1
0
mirror of https://github.com/dpc/tagwiki synced 2024-11-16 05:34:50 +00:00
Tag-addressed Rust wiki engine.
Go to file
2020-05-14 18:29:40 -07:00
.github Initial commit: template 2020-03-13 20:07:38 -07:00
ci Initial commit: template 2020-03-13 20:07:38 -07:00
docs Better support for journal-like usage. 2020-05-14 18:29:40 -07:00
resources Refactoring & rework 2020-05-12 23:53:33 -07:00
src Better support for journal-like usage. 2020-05-14 18:29:40 -07:00
.gitignore Initial commit: template 2020-03-13 20:07:38 -07:00
.travis.yml Better support for journal-like usage. 2020-05-14 18:29:40 -07:00
Cargo.lock Progress 2020-05-10 17:54:21 -07:00
Cargo.toml Progress 2020-05-10 17:54:21 -07:00
LICENSE-APACHE Initial commit: template 2020-03-13 20:07:38 -07:00
LICENSE-MIT Initial commit: template 2020-03-13 20:07:38 -07:00
LICENSE-MPL2 Initial commit: template 2020-03-13 20:07:38 -07:00
README.md Add better README 2020-05-13 00:32:27 -07:00
rustfmt.toml Initial commit: template 2020-03-13 20:07:38 -07:00

Travis CI Build Status crates.io #rust matrix channel rust-lang gitter channel

Tagwiki

Tagwiki is a wiki in which you link to pages by specifing hashtags they contain.

Example: /tagwiki/help link will lead to all pages that contain both #tagwiki and #help.

This allows effortless and self-structuring organization and editing experience, as the page collection grows and evolves.

My use-case

I just need a personal wiki, that I can throw random things into, that I don't have to pre-plan or carefully maintain.

User facing features and design goals

  • browser-based UI,
  • uses Markdown for content,
  • brutally simple,
  • fast,
  • excelent support for keyboard navigation,
  • keeps pages as markdown files in a directory,

Under the hood

  • Rust, async/await

Feature ideas:

  • "journal mode" - for easy note taking
  • support public-facing setups (authentication, permissions, and so on)

Installing & running

Like any Rust program. cargo install --git https://github.com/dpc/tagwiki.

To run tagwiki <markdown_files_directory>

See docs directory for more user-documentation. Pages inside it are tagwiki content, so you can try tagwiki ./docs try things out.