https://github.com/marketingpipeline/simply-docs

A simple, fast, free & easy to use static based plain HTML template. That allows you to make a beautiful personal / blog or technical documentation website really quickly.
https://github.com/marketingpipeline/simply-docs

api-documentation blog blog-theme css documentation documentation-site documentation-tool documentation-website free free-template github-pages html html-template markdown responsive self-hosted simply-docs syntax-highlighting template website

Last synced: about 2 months ago
JSON representation

A simple, fast, free & easy to use static based plain HTML template. That allows you to make a beautiful personal / blog or technical documentation website really quickly.

• Host: GitHub
• URL: https://github.com/marketingpipeline/simply-docs
• Owner: MarketingPipeline
• License: mit
• Created: 2022-04-20T03:54:15.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-10T03:23:58.000Z (over 2 years ago)
• Last Synced: 2023-03-05T04:58:09.754Z (almost 2 years ago)
• Topics: api-documentation, blog, blog-theme, css, documentation, documentation-site, documentation-tool, documentation-website, free, free-template, github-pages, html, html-template, markdown, responsive, self-hosted, simply-docs, syntax-highlighting, template, website
• Language: HTML
• Homepage: https://marketingpipeline.github.io/Simply-Docs/
• Size: 414 KB
• Stars: 76
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simply Docs



  





A simple, fast, free & easy to use static based plain HTML template. 
  That allows you to make a beautiful personal / blog or technical documentation website really quickly.

  

  

   


   Show your support! 

  


   

    

  

  

    

  

     

 


## Features:

  * Write in Pure HTML - there are NO CSS classes as it uses a classless CSS framework

* Ready to host on Github Pages!

* Markdown Support - made possible by [Markdown Tag](https://github.com/MarketingPipeline/Markdown-Tag) 

* Syntax Highlighting

* Automagic flipping to dark mode.

* Fully responsive.

* Apply your own CSS style with ease!

* Super lightweight & fast & easy to edit!

## Example and usage

You can find the Github Pages hosted demo of Simply Docs [here.](https://marketingpipeline.github.io/Simply-Docs/)

To use this template on Github Pages:

- Use this

[template](https://github.com/MarketingPipeline/Simply-Docs/generate)

- (Required) Make changes in the head section of the HTML pages to match your GitHub Repo name.

- Deploy to Github Pages

To use this template on your own hosting provider:

- Download:

[ZIP Folder](https://github.com/MarketingPipeline/Simply-Docs/archive/refs/heads/main.zip)

- Extract ZIP Folder

- (Required) Make changes in the head section of the HTML pages to match your corresponding directories.

- Upload to hosting provider

## Pages

 * [Home Page](https://marketingpipeline.github.io/Simply-Docs/)

 * [Documentation Page](https://marketingpipeline.github.io/Simply-Docs/pages/documentation)

 * [News Page](https://marketingpipeline.github.io/Simply-Docs/pages/news)

 * [Blog Post Page](https://marketingpipeline.github.io/Simply-Docs/pages/blog-post)

 * [Author Page](https://marketingpipeline.github.io/Simply-Docs/pages/author)

## Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/Simply-Docs)

Want to suggest design changes? Create a pull request with an image of the page with your updated design changes! If approved you will be added to the list of contributors of this awesome project!

See also the list of

[contributors](https://github.com/MarketingPipeline/Simply-Docs/graphs/contributors) who

participate in this project.

## License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/Simply-Docs)

This project is licensed under the MIT License - see the

[LICENSE.md](https://github.com/MarketingPipeline/Simply-Docs/blob/main/LICENSE) file for

details.