diff --git a/.gitignore b/.gitignore index 497bf45..c5a0c27 100644 --- a/.gitignore +++ b/.gitignore @@ -72,4 +72,4 @@ tools/python-fido2/* *.pem *.bin *.key - +site/ diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..6b10aaa --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +We are very open to contributions! diff --git a/docs/hosting.md b/docs/hosting.md new file mode 100644 index 0000000..9f6d0cc --- /dev/null +++ b/docs/hosting.md @@ -0,0 +1,9 @@ +Documentation of the `master` branch is deployed to Netlify automatically. + +To host or develop locally: + +- install python3 and pip +- `pip install mkdocs mkdocs-material` +- `mkdocs serve` and visit [localhost:8000](http://localhost:8000). + +The file `runtime.txt` is necessary to tell Netlify to use Python3. diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 32d46ee..0000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b29e554 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,4 @@ +Welcome to the technical documentation for [solokeyssec/solo](https://github.com/solokeyssec/solo). + +For now, you can read the repository `README.md`, more documentation to come! + diff --git a/docs/repo-readme.md b/docs/repo-readme.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/repo-readme.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a6eecc4..ae3e96a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,12 @@ site_description: 'Documentation for the SoloKeys solo software' repo_url: 'https://github.com/solokeyssec/solo' copyright: 'Copyright © 2018 SoloKeys' +nav: + - Home: index.md + - README.md: repo-readme.md + - Contributing: contributing.md + - Hosting: hosting.md + theme: name: material logo: 'images/logo.svg'