Online Docs Template 🌐

A template for creating documentation with markdown files online.

Check out the demo!

Getting Started 🍎

1. Create a new repository using this one as a template.
2. Clone your new repository to your desktop.
3. Initialize your repository...
   1. Install the dependencies with npm i.
   2. Rename .env.sample to .env and fill it with the appropriate info.
   3. Customize the metadata within your package.json.
4. Make it your own by editing the pages directory!

💡 Note: The README.md file in the pages directory represents the homepage of the site!

Editing Documents 🖊

Edit Existing (Online) 📝

1. Visit your live site.
2. Navigate to the page that you wish to edit.
3. Click the link at the top of the page to edit the document.
4. Commit your changes.

Create New (Online) 💡

1. Visit the pages directory on GitHub.
2. Navigate: Add file > Create new file.
3. Commit the new file.

Work on Desktop

1. Open your repository in your favorite code editor.
2. Edit the contents of the pages directory.
3. Commit your changes.

Deployment 🚀

1. Set your .env secrets in your GitHub repository: Settings > Secrets > New Secret.
2. Now, every push will trigger a deployment!

---

Drafted with 🧠 by EthanThatOneKid