bityard/silicon repository overview

⁠What's all this, then?!

Silicon Notes: A somewhat lightweight, low-friction personal knowledge base.

Features:

• Plaintext editing in Markdown, rendering in HTML
• Language syntax highlighting in rendered HTML
• Bi-directional page relationships
• Powerful full-text and page title search
• Page history
• A table of contents in the left sidebar, where it belongs
• A quite-usuable mobile layout
• Built-in documentation
• No-frills UI
• No big frameworks, just a few smallish dependencies

⁠

⁠

⁠

⁠Quickstart

This project is configured and deployed much like any other Flask project. For details, see the Flask configuration handling Docs⁠.

If you want to take this for a quick spin and have Docker installed, you can simply run:

docker run \
  -ti \
  --rm \
  --init \
  -p 127.0.0.1:5000:5000 \
  -v silicon_instance:/home/silicon/instance \
  bityard/silicon

And then open http://localhost:5000/⁠ with your local web browser.

For further information and deployment options, see the project's git repository at https://github.com/cu/silicon⁠