Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Move wiki to mkdocs #162

Closed
J0B10 opened this issue Dec 31, 2019 · 3 comments
Closed

Move wiki to mkdocs #162

J0B10 opened this issue Dec 31, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@J0B10
Copy link
Member

J0B10 commented Dec 31, 2019

Description

The wiki should be created by using mkdocs and deployed to the chatoverflow-gh-pages.

The goal is to make the wiki easier to read and to give it a unique theme that matches the theme of the deployment readme.

Also it allows us to benefit from some of the extended markdown features that come with pymdown.

References

@J0B10 J0B10 added the enhancement New feature or request label Dec 31, 2019
@J0B10 J0B10 self-assigned this Dec 31, 2019
@J0B10
Copy link
Member Author

J0B10 commented Jan 1, 2020

Working on this on my fork so I can easily test the deployment.
See the current progress under https://joblo2213.github.io/chatoverflow-gh-pages/.

@J0B10 J0B10 added this to the alpha 1 (4.0.0) milestone Jan 1, 2020
@J0B10
Copy link
Member Author

J0B10 commented Jan 2, 2020

Should we use a dark theme?

https://github.com/fmaida/mkdocs-material-dark-theme

@J0B10
Copy link
Member Author

J0B10 commented Jan 2, 2020

Nearly finished.

New wiki can already be accessed at http://docs.codeoverflow.org/.

Now only these steps are left:

  • Delete the old wiki and replace it with a link to the new one.
  • Update index.md. It should contain links to the most important pages and a short contrbuting guide.
  • Update README.md
  • Merge master branch of new wiki into develop and resolve merge conflicts.

@J0B10 J0B10 closed this as completed Jan 3, 2020
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant