flesh out docs a little
This commit is contained in:
parent
301bfcc866
commit
11b5a1af92
2
.gitignore
vendored
2
.gitignore
vendored
@ -72,4 +72,4 @@ tools/python-fido2/*
|
||||
*.pem
|
||||
*.bin
|
||||
*.key
|
||||
|
||||
site/
|
||||
|
1
docs/contributing.md
Normal file
1
docs/contributing.md
Normal file
@ -0,0 +1 @@
|
||||
We are very open to contributions!
|
9
docs/hosting.md
Normal file
9
docs/hosting.md
Normal file
@ -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.
|
@ -1 +0,0 @@
|
||||
../README.md
|
4
docs/index.md
Normal file
4
docs/index.md
Normal file
@ -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!
|
||||
|
1
docs/repo-readme.md
Symbolic link
1
docs/repo-readme.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
@ -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'
|
||||
|
Loading…
x
Reference in New Issue
Block a user