scy
/
braindocs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A system to create a website from my notes and journal and stuff.
21 Commits
1 Branch
0 Tags
112 KiB
Python 65.7%
Shell 34.3%
 
 
Go to file
Tim Weber 0c8ca10fd9
Use a custom insert_after regex 		2023-11-05 21:36:16 +01:00
docs Explain subfolders 2023-11-04 20:44:15 +01:00
mkdocs_pageage Use an insert_after regex for the age warning 2023-11-05 21:24:22 +01:00
.build.yml Include my old knowledge repo in the build 2023-10-24 16:30:20 +02:00
.gitignore Add script to setup symlinks 2023-11-04 17:39:45 +01:00
LICENSE.txt Add readme & license 2023-11-04 16:43:51 +01:00
README.md Explain subfolders 2023-11-04 20:44:15 +01:00
mkdocs.yml Use a custom insert_after regex 2023-11-05 21:36:16 +01:00
poetry.lock Install mkdocs-git-revision-date-localized-plugin 2023-10-24 16:28:24 +02:00
pyproject.toml Make pageage plugin configurable 2023-11-05 20:37:00 +01:00
setup-symlinks.sh Add script to setup symlinks 2023-11-04 17:39:45 +01:00

README.md

braindocs

This is the system that I use to create a website out of my notes and stuff.

There will be more documentation at some point.

Sources

This repository does not contain any of the actual notes and articles. These live elsewhere and are only symlinked in here using setup-symlinks.sh (see below).

The following repositories are currently used, and which sections they contain:

Installation

  1. Install Poetry.
  2. poetry install --no-root
  3. ./setup-symlinks.sh

Running

To run the system with live reloading:

poetry run mkdocs serve

You can use -a localhost:8123 to set a different port.

Building

To build for deployment:

poetry run mkdocs build

The output will be in dist/. You can use -d somewhere-else to change the output directory.

License

MIT. Note that this license only refers to this software repository, not the actual content of the documentation.