{"id":19082330,"url":"https://github.com/starfallprojects/quick-docs","last_synced_at":"2026-02-11T02:33:45.565Z","repository":{"id":117642570,"uuid":"450110902","full_name":"StarfallProjects/quick-docs","owner":"StarfallProjects","description":"Quickly deploy a full-featured docs setup to Cloudflare Pages","archived":false,"fork":false,"pushed_at":"2022-01-25T14:18:14.000Z","size":47,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-22T12:42:09.250Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StarfallProjects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-20T13:35:51.000Z","updated_at":"2022-01-25T13:04:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"47aeb86f-4aa4-4ac8-8c45-7b9068b8d825","html_url":"https://github.com/StarfallProjects/quick-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/StarfallProjects/quick-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Fquick-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Fquick-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Fquick-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Fquick-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StarfallProjects","download_url":"https://codeload.github.com/StarfallProjects/quick-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Fquick-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272024685,"owners_count":24860528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T02:42:56.615Z","updated_at":"2026-02-11T02:33:45.542Z","avatar_url":"https://github.com/StarfallProjects.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quick docs\n\nQuickly deploy a full-featured docs setup to Cloudflare Pages.\n\nThis is an opinionated setup: I have chosen to enable and configure features I usually want, such as navigation tabs and admonitions.\n\n## Features\n\n- MkDocs with the Material theme\n- Vale GitHub Action\n- Support for [Plausible](https://plausible.io/) analytics\n\n## Quickstart\n\n1. Copy the contents of this repo to your own repo.\n2. Follow the instructions on [how to deploy MkDocs to Cloudflare Pages](https://starfallprojects.co.uk/projects/deploy-host-docs/deploy-mkdocs-material-cloudflare/). Note that this example repo uses the free version of Material. Once done, you have a live site!\n\n## Work on the site\n\n1. Clone your repo.\n2. Create a virtual environment:\n    ```\n    python -m venv venv\n    ```\n3. Activate your virtual environment:\n    ```\n    # PowerShell\n    /venv/Scripts/activate.ps1\n    ```\n4. Install requirements:\n    ```\n    pip install -r requirements.txt\n    ```\n    \u003e **Note:** there are several ways to install the Material theme, which is the cornerstone of this project. But you must install using pip in order to use some features. I strongly recommend using pip.\n5. View locally with `mkdocs serve`.\n\n## Configure the site\n\n## Using Vale\n\nVale provides linting, both locally and on pull request.\n\nThe setup in this repo includes the following styles:\n\n- [Microsoft](https://github.com/errata-ai/Microsoft): a Vale-compatible implementation of the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).\n- [write-good](https://github.com/errata-ai/write-good)\n- [alex](https://github.com/errata-ai/alex): a Vale-compatible implementation of the guidelines enforced by the alex, a linter designed to catch insensitive writing.\n\n### Configure your styles\n\n1. In `styles`, rename `your-company-styles` to your company name, and in `.vale.ini` change `your-company-styles` to the new directory name.\n2. In `styles/Vocab/default`, add any terms you want Vale to accept or reject to the appropriate `.txt` file. This is useful for allowing company-specific terminology (such as brand names) to pass the spell checker. Learn more about [Vale vocabularies](https://docs.errata.ai/vale/vocab).\n\n### To lint your local files, you can:\n\n- [Install Vale CLI](https://docs.errata.ai/vale/install) and run it with `vale --glob='*.md' docs` (this lints all Markdown files in your `docs` directory)\n- Install Vale CLI or Vale Server, and use with one of the integrations, such as the VS Code extension. There is a list of integrations in the [docs](https://docs.errata.ai/).\n\n### To lint on pull request, enable the GitHub Action:\n\n\n\n## Resources\n\nThe `mkdocs.yml` includes links to documentation on each theme feature that I'm using. The Material theme is the foundation of this project, and its [documentation](https://squidfunk.github.io/mkdocs-material/) is extensive and very helpful. You can also learn more about [MkDocs](https://www.mkdocs.org/), the static site generator underpinning the theme.\n\nVale is a complex linting tool. The [documentation](https://docs.errata.ai/) is a good starting point.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarfallprojects%2Fquick-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstarfallprojects%2Fquick-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarfallprojects%2Fquick-docs/lists"}