The site is served as GitHub Pages at https://docs.freeplane.org/.
The main site is Docs
, with Attic
as a sub-directory.
Attic
contains MediaWiki pages (pre-2022 wiki) migrated to Markdown for GitHub.
The vision is to bring all MediaWiki content from Attic
to Docs
.
Some content in Attic
might be outdated, some unconverted, some media files missing.
Each attic
page needs to be reviewed/completed before incorporating it to Docs
.
When a page is incorporated to Docs
and removed from Attic
, all existing Attic
pages linking to it should be updated.
Relative links should be used.
The site uses docsify with the following options/plugins:
- relativePath: true
- nested sidebars with CSS in index.html
- header and footer hook
- search plugin with a dedicated namespace for each site
- image zoom plugin
- Groovy language syntax highlight
- Bash/Shell syntax highlight
- Install python, if not already available โ https://www.python.org/downloads/
- Clone the repository, e.g.
git clone https://github.com/freeplane/docs.git
- Change directory to docs
cd docs
and run python http server:python -m http.server 3000
โ Manually preview your site - Browse the site at http://127.0.0.1:3000/