mirror of
https://github.com/codeninjasgg/roblox-royale-camp.git
synced 2024-11-23 15:57:59 -05:00
2.1 KiB
2.1 KiB
Online Docs Template 🌐
A template for creating documentation with markdown files online.
Check out the demo!
Getting Started 🍎
- Create a new repository using this one as a template.
- Clone your new repository to your desktop.
- Initialize your repository...
- Install the dependencies with
npm i
. - Rename
.env.sample
to.env
and fill it with the appropriate info. - Customize the metadata within your
package.json
.
- Install the dependencies with
- Make it your own by editing the
pages
directory!
💡 Note: The
README.md
file in thepages
directory represents the homepage of the site!
Editing Documents 🖊
Edit Existing (Online) 📝
- Visit your live site.
- Navigate to the page that you wish to edit.
- Click the link at the top of the page to edit the document.
- Commit your changes.
Create New (Online) 💡
- Visit the
pages
directory on GitHub. - Navigate:
Add file > Create new file
. - Commit the new file.
Work on Desktop
- Open your repository in your favorite code editor.
- Edit the contents of the
pages
directory. - Commit your changes.
Deployment 🚀
- Set your
.env
secrets in your GitHub repository:Settings > Secrets > New Secret
. - Now, every push will trigger a deployment!
Drafted with 🧠 by EthanThatOneKid