This directory contains the documentation site for Event Sentinel, designed to be hosted on GitHub Pages.
index.html- Main landing pagefeatures.html- Complete feature listsetup.html- Setup and installation guideconfiguration.html- Configuration optionsprivacy.html- Privacy Policyterms.html- Terms of Servicestyles.css- Main stylesheet
To deploy this documentation to GitHub Pages:
-
Enable GitHub Pages:
- Go to your repository settings
- Navigate to "Pages" in the left sidebar
- Under "Source", select the branch containing the
docsfolder - Select
/docsas the folder - Click "Save"
-
Access Your Site:
- Your documentation will be available at:
https://<username>.github.io/<repository-name>/
-
Custom Domain (Optional):
- Add a
CNAMEfile in thedocsfolder with your domain name - Configure DNS settings as per GitHub's instructions
- Add a
To test the documentation locally, simply open index.html in a web browser or use a local server:
# Using Python
python -m http.server 8000
# Using Node.js (http-server)
npx http-server
# Then visit http://localhost:8000- The
.nojekyllfile tells GitHub Pages to serve the site as static HTML without Jekyll processing - All pages use relative links, so they work both locally and on GitHub Pages
- The site is fully responsive and works on mobile devices