Add MkDocs config to compare both outputs.

carlosperate · Nov 3, 2019 · bbb6472 · bbb6472
1 parent f0c9016
commit bbb6472
Show file tree

Hide file tree

Showing 5 changed files with 154 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,8 @@
 .vscode/
 .vagrant/
 .sass-cache
-_site
+_site/
+_site_mkdocs/
 
 ###########
 # Node.js #

diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,12 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+mkdocs = "*"
+
+[requires]
+python_version = "3.6"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -14,6 +14,12 @@ This theme is ported from the MkDocs port of the Read The Docs Sphinx theme.
 License and copyright for the theme can be found in the
 [LICENSE-mkdocs](LICENSE-mkdocs) file.
 
+To compare the output from MkDocs:
+
+```
+mkdocs build
+```
+
 -----
 
 Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,7 @@
+site_name: 'Read The Docs Jekyll Theme'
+site_description: 'Port of the Read the Docs theme to Jekyll to use with GitHub Pages.'
+repo_url: 'https://github.com/carlosperate/jekyll-theme-rtd'
+repo_name: 'GitHub'
+docs_dir: 'docs/'
+site_dir: '_site_mkdocs/'
+theme: 'readthedocs'