Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation site #12

Open
msplr opened this issue May 20, 2019 · 1 comment
Open

Documentation site #12

msplr opened this issue May 20, 2019 · 1 comment
Assignees
@msplr
Labels
enhancement New feature or request question Further information is requested

Comments

@msplr
Copy link

msplr commented May 20, 2019

We should add a documentation website for this project.
MkDocs is a good option which is easy to set up and works with GitHub Pages.

However, it might be challenging to set it up for a branch other than master.
@msplr msplr added enhancement New feature or request question Further information is requested labels May 20, 2019
@msplr msplr self-assigned this May 20, 2019
@msplr
Copy link
Author

msplr commented May 20, 2019

This might help setting it up from another branch:
https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@msplr msplr

Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@msplr