Skip to content

Using Jekyll and Python convert GeoDms Github Wiki to static html

License

Notifications You must be signed in to change notification settings

ObjectVision/GeoDmsWikiToStaticHtml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Intro

Github wiki content is generally not allowed to be indexed by third-parties like Google Search. GeoDmsWikiToStaticHtml is a tool to convert public Github wiki content to static html content. This allows the wiki content to be duplicated neatly and served at a location that allows for indexing, while keeping the source in one location.

Installation

Usage

  1. git clone https://github.com/ObjectVision/GeoDmsWikiToStaticHtml.git
  2. Change parameter wiki_git_url in convert_wiki_to_static_html.py to the a Github wiki repository of your choice
  3. Change directory in terminal to GeoDmsWikiToStaticHtml
  4. From command line: python convert_wiki_to_static_html.py

This will run through several steps:

  • Clone the wiki repository locally
  • Parse the _Sidebar.md and use it as navigation bar
  • Convert internal image and file links "[[ ]]" to "" format
  • Run: bundle exec jekyll serve

If all went well the static html pages are build and served locally. Major thanks to just the docs for their awesome template.

Testing

When done building, go into the template/_Site folder. From there any static html host tool can be used. For instance:

python -m http.server 8000

About

Using Jekyll and Python convert GeoDms Github Wiki to static html

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published