tagwiki/README.md

1.9 KiB

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,
  • excellent support for keyboard navigation,
  • keeps pages as markdown files in a directory,
  • convenient logs/journals/note taking

How it looks

tagwiki screenshot

Under the hood

  • Rust, async/await

Feature ideas:

  • 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 use tagwiki ./docs to try things out.