CleanDocs A Documentation Template

CleanDocs is a free and open-source documentation template built using html, tailwindcss, and javascript.

lmas3009 / cleandocs-template

A documentation template built using HTML, Tailwindcss, and Javascript

cleandocs-template

A documentation template built using HTML, Tailwindcss and Javascript

Clone the repository

git clone https://github.com/lmas3009/cleandocs-template.git

Contributing

All code contributions - if you want change the ui - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

After making changes add your information in contributors section in index.html

We truly ❤️ pull requests! If you wish to help.

✅   Add your information on website, please follow Contribution Guide

Visual Representation

flowchart TD
  A[lmas3009/cleandocs-template] --> B{Get This Repo}
  B -- By Fork --> C[yourusername/cleandocs-template]
  B -- By Clone --> D[Your Local Repo];
  C ----> E[Create New Branch];
  D ----> E[Create New Branch];
  E --> F[Made Some Changes];
  F --> G[Commit Changes];
  G -- On GitHub --> H[Create Pull Request];
  H -- If Rejected --> F[Made Changes Again];
  H -- If Approved --> I[Changes

…

View on GitHub

If you want to work on this or adding this to your website. Just fork or clone the repository.

git clone https://github.com/lmas3009/cleandocs-template

You can also look at the Live Site: Live

This is the Home Page of cleandocs website:

This is the documentation page of cleandocs:

This is my first time building this type of documentation page from scratch.

If you want to give any suggestions on a redesign or any changes. 
Please share your response through Github Discussion or to my Twitter Acc.

❤❤ Thanks for reading this article. ❤❤

Comments

[Aravind Kumar Vemula]

github.com/lmas3009/cleandocs-temp...

who are willing to contribute towards opensource

[Jan Cizmar]

Hi, seems cool. Why should I use this and not Docusaurus?

[Aravind Kumar Vemula]

Hi,
CleanDocs is a basic template which is not the advanced one.
This is my first time building template design from scratch.

I am not telling every one to use this template but i am looking for feedback and suggestions on this project.

[Jan Cizmar]

Right. I Thought that, you mean this as serious thing, when you are looking for contributions. My feedback would be.

1. Use React, since your HTML + CSS approach is full of boilerplate and it would be hard to use.
2. Enable users to add Markdown. It's faster then writing HTML for documentation

[Aravind Kumar Vemula]

Thanks Jan, for your feedback.
I will look into it and try to update it.

[Shrikant Dhayje]

oh it's something similar to docusaurus, cool 👌.

[Shrikant Dhayje]

I Also Made some minor changes and added PR request