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

Automatically convert GitHub Wikis to MarkBind sites #675

Closed
Xenonym opened this issue Feb 7, 2019 · 1 comment · Fixed by #698
Closed

Automatically convert GitHub Wikis to MarkBind sites #675

Xenonym opened this issue Feb 7, 2019 · 1 comment · Fixed by #698

Comments

@Xenonym
Copy link
Contributor

Xenonym commented Feb 7, 2019

Tell us about your environment

  • MarkBind Version: 1.17.2

Rationale: GitHub Wikis are used commonly for project documentation (eg. Angular.JS, d3). It would be viable to support automatic conversions for wikis as they are all flat directories of Markdown files in a Git repository, which should be relatively simple to implement.

In addition, we can also convert a wiki's custom footers and sidebars (_Footer.md, _Sidebar.md) to our corresponding footer.md and site-nav.md. Additionally, many wikis use a sidebar that is generated by github-wiki-sidebar, whose output can cleanly translate to our own site-nav.md:

* [Installation](./Installation)
* [Roadmap](./Roadmap)
* [Usage](./Usage)
  * [Command line modifiers](./Usage%3A-Command-line-modifiers)
  * [Default mode (enquire)](./Usage%3A-Default-mode-(enquire))
  * [Tutorial mode](./Usage%3A-Tutorial-mode)
* [Examples](./Examples)

Alternatively, we can parse the file listing of the GitHub wiki to generate the site nav.

@yamgent
Copy link
Member

yamgent commented Feb 8, 2019

Good idea, looking forward to your implementation. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants