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.

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

Create a webpage #17

Closed
2 tasks done
josecelano opened this issue Jun 3, 2022 · 1 comment · Fixed by #22
Closed
2 tasks done

Create a webpage #17

josecelano opened this issue Jun 3, 2022 · 1 comment · Fixed by #22
Labels
good first issue Good for newcomers

Comments

@josecelano
Copy link
Member

josecelano commented Jun 3, 2022

We want to offer the same content on a webpage using GitHub Pages.

We want to use MKDocs for the time being since we are also using it on other projects.

TASKS:

  • Setup mkdocs.
  • Move content to mkdocs markdown pages. I suppose the whole repo (main branch) could be the MKDocs page. We do not need a docs folder. Setup gh-pages with root.

NOTES:

  • I would recommend using one of these two MKDocs themes: gitbook, cinder.
@josecelano
Copy link
Member Author

Finally, we use the docs subfolder because we have a lot of MegaLinter configuration stuff that we do not want to mix with the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant