feat: use github pages and jekyll for docs

This commit is contained in:
Eneko Illarramendi
2020-05-04 17:20:36 +02:00
parent a61d346669
commit b37af0c600
10 changed files with 173 additions and 13 deletions

12
docs/devs/api.md Normal file
View File

@ -0,0 +1,12 @@
---
layout: default
parent: For developers
title: API reference
nav_order: 3
---
API reference
=============
Coming soon...

12
docs/devs/development.md Normal file
View File

@ -0,0 +1,12 @@
---
layout: default
title: For developers
nav_order: 3
has_children: true
---
For developers
==============
Thanks for contributing :)

12
docs/devs/extensions.md Normal file
View File

@ -0,0 +1,12 @@
---
layout: default
parent: For developers
title: Making extensions
nav_order: 2
---
Making extensions
=================
Coming soon...

34
docs/devs/installation.md Normal file
View File

@ -0,0 +1,34 @@
---
layout: default
parent: For developers
title: Installation
nav_order: 1
---
Installation
============
LNbits uses [Flask](http://flask.pocoo.org/).
Application dependencies
------------------------
The application uses [Pipenv][pipenv] to manage Python packages.
While in development, you will need to install all dependencies (includes packages like `black` and `flake8`):
$ pipenv shell
$ pipenv install --dev
Running the server
------------------
$ flask run
There is an environment variable called `FLASK_ENV` that has to be set to `development`
if you want to run Flask in debug mode with autoreload
[pipenv]: https://docs.pipenv.org/#install-pipenv-today