Commit 232301fc authored by tavit ohanian's avatar tavit ohanian

fix markdown syntax

parent 645a1bd8
# to support diagrams in markdown documents, add atom package:
# "Markdown Preview Enhanced"
# use mkdocs to generate documentation site using markdown.
#
# mkdocs setup
# references:
# https://www.mkdocs.org/
# https://www.mkdocs.org/user-guide/configuration/
# https://github.com/mkdocs/mkdocs/
# https://github.com/shd101wyy/markdown-preview-enhanced/blob/master/docs/diagrams.md
#
# use mkdocs pymdown-extensions with superfences and custom fences to
# support diagrams in mkdocs.
# https://facelessuser.github.io/pymdown-extensions/
# https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
# https://mermaidjs.github.io/#/
# https://github.com/squidfunk/mkdocs-material/issues/693
# https://cdnjs.com/
# https://github.com/mermaid-https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-programming-environment-on-debian-10js/mermaid/
# DMS3 Draft documentation
To add support diagrams in markdown documents, add Atom packages: "Markdown Preview Enhanced".
Use mkdocs to generate documentation site using markdown.
mkdocs setup:
References:
- https://www.mkdocs.org/
- https://www.mkdocs.org/user-guide/configuration/
- https://github.com/mkdocs/mkdocs/
- https://github.com/shd101wyy/markdown-preview-enhanced/blob/master/docs/diagrams.md
Use mkdocs pymdown-extensions with superfences and custom fences to support diagrams in mkdocs:
- https://facelessuser.github.io/pymdown-extensions/
- https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
- https://mermaidjs.github.io/#/
- https://github.com/squidfunk/mkdocs-material/issues/693
- https://cdnjs.com/
- https://github.com/mermaid-https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-programming-environment-on-debian-10js/mermaid/
```bash
mkdir -p ~/Work/dapp/dms3
mkdir -p ~/Work/dapp/dms3/mkdocs-docs
mkdir -p ~/Work/dapp/dms3/dms3-docs
cd ~/Work/dapp/dms3
```
#
#Note: mermaid was removed after the mkdocs documentation was functional
#initially the docs folder was setup as ~/Work/dapp/dms3/mkdocs-docs,
#but later moved to ~/Work/dapp/dms3-docs
#
#Note: use clone of repo mermaid - cdnjs version has bad css that when a
# style is added to flowchart svg, the page is disabled.
# to build mermaid locally after cloning repo:
Initial install was via cloning the repo as below.
Use clone of repo mermaid - cdnjs version has bad css that when a style is added to flowchart svg, the page is disabled. To build mermaid locally after cloning repo:
```bash
git clone https://github.com/mermaid-js/mermaid.git
cd mermaid/
nvm list
......@@ -50,8 +51,13 @@ pip --version
#
#wget https://bootstrap.pypa.io/get-pip.py
#sudo python get-pip.py
# follow this instead to setup a virtual python environment
#https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-programming-environment-on-debian-10
```
Later install followed this instead to setup a virtual python environment
- https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-
set-up-a-programming-environment-on-debian-10
```bash
sudo apt update
sudo apt -y upgrade
python3 -V
......@@ -77,17 +83,19 @@ pip install mkdocs-rtd-dropdown
mkdocs build
mkdocs serve
```
To support math rendering:
- https://stackoverflow.com/questions/27882261/mkdocs-and-mathjax/31926644
- https://squidfunk.github.io/mkdocs-material/extensions/pymdown/
- https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
# to support math rendering:
# https://stackoverflow.com/questions/27882261/mkdocs-and-mathjax/31926644
# https://squidfunk.github.io/mkdocs-material/extensions/pymdown/
# https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
- roboto-slab fonts were downloaded from:
- Free download fonts at http://sharefonts.net
- unzip and move missing fonts into mkdocs-docs/docs/fonts/
# roboto-slab fonts were downloaded from:
# Free download fonts at http://sharefonts.net
# unzip and move missing fonts into mkdocs-docs/docs/fonts/
## Usage
# usage
```bash
cd ~/Work/dapp/dms3-docs
# build
......@@ -100,3 +108,4 @@ mkdocs serve --dev-addr=192.168.0.7:8000
# deploy
rsync -rv site/* gitlab.dms3.io:~/dms3-docs/site/
/sbin/apache2ctl restart
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment