# Online Docs Template 🌐
> A template for creating documentation with markdown files online.

[![GitHub forks](https://img.shields.io/github/forks/EthanThatOneKid/online-docs-template?style=social)](https://github.com/EthanThatOneKid/online-docs-template/fork)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/EthanThatOneKid/online-docs-template/Deploy)](https://github.com/EthanThatOneKid/online-docs-template/actions?query=workflow%3ADeploy)
![GitHub repo size](https://img.shields.io/github/repo-size/EthanThatOneKid/online-docs-template)

Check out the [demo](https://ethanthatonekid.github.io/online-docs-template/)!

## Getting Started 🍎
1. Create a new repository using this one as a [template](https://github.com/EthanThatOneKid/online-docs-template/generate).
1. Clone your new repository to your desktop.
1. Initialize your repository...
	1. Install the dependencies with `npm i`.
	1. Rename [`.env.sample`](.env.sample) to `.env` and fill it with the appropriate info.
	1. Customize the metadata within your [`package.json`](package.json).
1. Make it your own by editing the [`pages`](pages) directory!

> 💡 Note: The [`README.md`](pages/README.md) file in the [`pages`](pages) directory represents the *homepage* of the site!

## Editing Documents 🖊

### Edit Existing (Online) 📝
1. Visit your live site.
1. Navigate to the page that you wish to edit.
1. Click the link at the top of the page to edit the document.
1. Commit your changes.

### Create New (Online) 💡
1. Visit the [`pages`](pages) directory on GitHub.
1. Navigate: `Add file > Create new file`.
1. Commit the new file.

### Work on Desktop
1. Open your repository in your favorite code editor.
1. Edit the contents of the [`pages`](pages) directory.
1. Commit your changes.

## Deployment 🚀
1. Set your [`.env`](.env.sample) secrets in your GitHub repository: `Settings > Secrets > New Secret`.
1. Now, every push will trigger a deployment!

---

[![Buy me a Coffee](https://img.shields.io/badge/buy%20me%20a-coffee-%23FF813F)][bmac]

Drafted with 🧠 by [EthanThatOneKid][creator_site]

[bmac]: http://buymeacoff.ee/etok
[creator_site]: http://ethandavidson.com/