Browse Source

website setup with mkdocs for online documentation

Jaromil 1 year ago
parent
commit
116dfff13d
4 changed files with 16 additions and 0 deletions
  1. 1 0
      docs/website/.gitignore
  2. 9 0
      docs/website/README.md
  3. 1 0
      docs/website/docs/index.md
  4. 5 0
      docs/website/mkdocs.yml

+ 1 - 0
docs/website/.gitignore

@@ -0,0 +1 @@
1
+site

+ 9 - 0
docs/website/README.md

@@ -0,0 +1,9 @@
1
+# Build
2
+
3
+Instructions to build this website:
4
+```
5
+sudo apt-get install python3-pip
6
+sudo pip3 install mkdocs
7
+sudo pip3 install mkdocs-windmill
8
+mkdocs build
9
+```

+ 1 - 0
docs/website/docs/index.md

@@ -0,0 +1 @@
1
+../../article/views/decode_language_patterns.md

+ 5 - 0
docs/website/mkdocs.yml

@@ -0,0 +1,5 @@
1
+site_name: DECODE language
2
+site_description: Secure language design patterns for use in blockchain smart-contracts: restricted execution environments for deterministic, provable and distributed computing of algorithms.
3
+site_author: Jaromil, DECODE project
4
+theme: windmill
5
+repo_url: https://gogs.dyne.org/decode/decode-lang