Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 3.14 KB

README.md

File metadata and controls

86 lines (57 loc) · 3.14 KB
Raw

Welcome to Phoenix Documentation

This repository hosts the code for https://docs.phcode.dev/ . Please contribute to this repo for helping the Phoenix/Brackets community.

Developing

Requirements

  • Git — latest source release
  • Node.js — latest LTS version or newer

After cloning this repo locally, follow the below commands to start modifying Phoenix docs.

1. Install dependencies

npm install

2. Start development server

npm run start

After starting the server, visit http://localhost:1313/ to preview your changes.

3. Verifying generated static files

After completing development, you should verify if the static files generated are correct. Run the following command:

npm run build
npm run serveStatic

Then go to http://127.0.0.1:8080 to verify the static file changes

4. Submitting your changes

  • Raise a pull request to this GitHub repo after making your changes.
  • docs.phcode.dev will be automatically updated with your code once the pull request is merged.

More Documentation

Based on Docs template

This repo is based on the Hugo template Doks. Doks brings in the following features:

We should verify docs.phcode.dev for these features!

  1. Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.

  2. Fast by default. Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.

  3. SEO-ready. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.

  4. Development tools. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.

  5. Bootstrap framework. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.

  6. Netlify-ready. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.

  7. Full text search. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.

  8. Page layouts. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.

  9. Dark mode. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.

Other features

  • Multilingual and i18n support
  • Versioning documentation support
  • KaTeX math typesetting
  • Mermaid diagrams and visualization
  • highlight.js syntax highlighting

License

AGPL 3.0 Copyright (c) 2022-present, core.ai

Based on Doks template by Copyright (c) 2018-present, Gridsome Copyright (c) 2020-present, Henk Verlinde