This project provides a shell script to generate static websites from Markdown files using popular static site generators. The script supports MkDocs, Hugo, VuePress, and Docsify, allowing you to select themes and plugins interactively.
The purpose of this project is to help users quickly set up and preview static websites using different frameworks. This can be particularly useful for generating documentation sites, blogs, or any other static content websites.
- Python
- pip
- mkdocs
- hugo
- yarn
- docsify-cli
-
Clone the repository:
git clone https://github.com/yourusername/awesome-list-site-generator.git cd awesome-list-site-generator -
Make the script executable:
chmod +x setup_frameworks.sh
-
Run the script with your
README.mdfile and the desired output directory. Optionally use the--interactiveflag to enable interactive theme and plugin selection:./setup_frameworks.sh path/to/README.md output/directory [--interactive]
README_FILE: Path to yourREADME.mdfile.OUTPUT_DIRECTORY: Directory where the generated sites will be stored.--interactive: (Optional) Enable interactive mode for selecting themes and plugins.
The script supports a variety of themes and plugins for each framework. Below are the available options:
- mkdocs
- readthedocs
- material
- alabaster
- mkdocs-bootstrap
- mkdocs-cinder
- mkdocs-rtd-dropdown
- mkdocs-windmill
- mkdocs-yeti
- slate
- mkdocs-material
- mkdocs-alabaster
- mkdocs-bootstrap4
- mkdocs-insiders
- theNewDynamic/gohugo-theme-ananke
- bep/hyde
- spf13/hyde
- kubeflow/hugo-multilingual
- henrythemes/hugo-theme-minimo
- zenorocha/fliptheme
- calintat/minimal
- halogenica/beautifulhugo
- track3/hermit
- budparr/gohugo-theme-ananke
- digitalcraftsman/hugo-agency-theme
- htr3n/hyde-hyde
- muesli/beautifulhugo
- mathieudutour/hugo-drawer
- lucperkins/hugo-fresh
- vuepress/theme-default
- vuepress/theme-blog
- vuepress/theme-vue
- vuepress/theme-craft
- vuepress/theme-medium
- vuepress/theme-yuque
- vuepress/theme-book
- vuepress/theme-cosmos
- vuepress/theme-reco
- vuepress/theme-vdoing
- vuepress/theme-hope
- vuepress/theme-antdocs
- vuepress/theme-modern-blog
- vuepress/theme-ououe
- vuepress/theme-succinct
- vue
- dark
- buble
- pure
- doka
- vuepress
- minty
- flatly
- readable
- materia
- cinder
- docsify-themeable
- docsify-themeable-dark
- docsify-themeable-light
- docsify-themeable-modern
- search
- macros
- redirects
- minify
- table-reader
- google-analytics
- sitemap
- git-revision-date
- social
- tags
- autoprefixer
- postcss
- babel
- sass
- imagemin
- hugo-extended
- hugo-analytics
- hugo-seo
- hugo-deploy
- hugo-redirects
- @vuepress/plugin-back-to-top
- @vuepress/plugin-medium-zoom
- @vuepress/plugin-nprogress
- @vuepress/plugin-google-analytics
- @vuepress/plugin-blog
- @vuepress/plugin-seo
- @vuepress/plugin-pwa
- @vuepress/plugin-sitemap
- @vuepress/plugin-pagination
- @vuepress/plugin-reading-time
- docsify-plugin-search
- docsify-plugin-tabs
- docsify-plugin-zoom-image
- docsify-plugin-pagination
- docsify-plugin-mathjax
- docsify-plugin-gtag
- docsify-plugin-seo
- docsify-plugin-ga
- docsify-plugin-sitemap
- docsify-plugin-pwa
- MkDocs Themes
- Hugo Themes
- VuePress Themes
- Docsify Themes
- MkDocs Plugins
- Hugo Plugins
- VuePress Plugins
- Docsify Plugins
Contributions are welcome! Please feel free to submit a Pull Request or open an issue.
This project is licensed under the MIT License.