{"id":20201501,"url":"https://github.com/niravcodes/docusaurus-blank-starter","last_synced_at":"2026-06-09T10:31:54.196Z","repository":{"id":249306957,"uuid":"830924093","full_name":"niravcodes/docusaurus-blank-starter","owner":"niravcodes","description":"Docusaurus starter, but blank and ready to roll out","archived":false,"fork":false,"pushed_at":"2024-07-24T21:35:02.000Z","size":643,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-30T18:41:26.654Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/niravcodes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-07-19T09:32:33.000Z","updated_at":"2025-03-27T18:09:24.000Z","dependencies_parsed_at":"2024-07-20T00:47:40.959Z","dependency_job_id":"8d2e67ee-e7e2-4188-8aaf-4112c35d9188","html_url":"https://github.com/niravcodes/docusaurus-blank-starter","commit_stats":null,"previous_names":["niravcodes/docusaurus-blank-starter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/niravcodes/docusaurus-blank-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocusaurus-blank-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocusaurus-blank-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocusaurus-blank-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocusaurus-blank-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/niravcodes","download_url":"https://codeload.github.com/niravcodes/docusaurus-blank-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niravcodes%2Fdocusaurus-blank-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34103355,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"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-14T04:51:26.558Z","updated_at":"2026-06-09T10:31:54.172Z","avatar_url":"https://github.com/niravcodes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\n\nThe usual Docusaurus initialization with `npx create-docusaurus@latest my-website classic`\ncomes with a lot of dummy content that I must remove.\n\nThat is probably okay for most people who will start a documentation once every few months.\n\nBut I hope to place a copy of Docusaurus in every project I have, by default. And I don't want to go\nthrough the desolate process of de-dummifying a new doc everytime. I plan to use this blank\ntemplate instead of the official starter template.\n\nGet started quick with:\n\n```bash\nnpx create-docusaurus@latest -g copy doc-for-x https://github.com/niravcodes/docusaurus-blank-starter\n```\n\n## Major changes to the starter\n\n- Simplified or removed most introductory artefact, removed the Blog feature, and simplified the homepage\n- Preinstalled Mermaid for diagramming and Katex for Math notation\n- The favicon, and all other images are now simple and non-dinosaur-including (nothing against dinosaurs in general,\n  but cute green dinosaurs don't say \"cool\").\n- a `simpleConfig` object in `docusaurus.config.ts` centralizes most things you'd want to change in a\n  new doc site without having to parse the entire config\n\n  ```js\n  const simpleConfig = {\n    title: \"Documentation for X\",\n    tagline: \"This is the documentation for X.\",\n\n    ghUser: \"niravcodes\",\n    ghRepo: \"\",\n\n    url: \"https://your-docusaurus-site.example.com\",\n    baseUrl: \"/\",\n  };\n  ```\n\n- Default color changed from green to blue\n- Removed footer\n\n## Low-effort installation\n\n1. **Initialize the doc**\n\n   ```bash\n   npx create-docusaurus@latest -g copy doc-for-x https://github.com/niravcodes/docusaurus-blank-starter\n\n   # or\n\n   git clone https://github.com/niravcodes/docusaurus-blank-starter\n   cd docusaurus-blank-starter\n   npm install\n   ```\n\n   I recommend that you store the docs in the same directory and repo where your code also lives ([Docs as Code]).\n\n[Docs as Code]: https://www.writethedocs.org/guide/docs-as-code/\n\n2. Edit the `simpleConfig` object in `docusaurus.config.ts` config file to reflect your project\n\n## High-effort installation\n\n1. Follow low effort installation first\n2. Edit the images in `static/img/` to reflect your brand\n3. Edit the colors in `src/css/custom.css` to reflect your brand. A handy CSS generator and tester is available\n   in the [Docusaurus Docs](https://docusaurus.io/docs/styling-layout#styling-your-site-with-infima)\n4. If you don't need Mermaid and Katex, remove them from `package.json` and `docusaurus.config.ts`.\n5. If you need a homepage that is not the docs index:\n\n   a. Remove the line `routeBasePath: \"/\",` from the `docs` preset config in `docusaurus.config.ts`.\n\n   b. Rename `src/pages/somepage.tsx` to `src/pages/index.tsx` and write your homepage in React.\n\n## Additional things not included by default\n\n### TypeScript documentation with TypeDoc\n\nIf you are documenting a TypeScript project, you can use Typedoc to have code-reference style docs generated from\nthe code and the comments, on top of all the hand-written text.\n\nTo set that up, use [docusaurus-plugin-typedoc] like so:\n\n```bash\nnpm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev\n```\n\n```typescript title=\"docusaurus.config.ts\"\nmodule.exports = {\n  // Add option types\n  // ...\n\n  plugins: [\n    [\n      \"docusaurus-plugin-typedoc\",\n\n      // Options\n      {\n        entryPoints: [\"../src/index.ts\"],\n        tsconfig: \"../tsconfig.json\",\n      },\n    ],\n\n    // ...\n  ],\n};\n```\n\n[docusaurus-plugin-typedoc]: https://typedoc-plugin-markdown.org/plugins/docusaurus\n\n### Other resources:\n\n[https://docusaurus.io/community/resources](https://docusaurus.io/community/resources)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniravcodes%2Fdocusaurus-blank-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fniravcodes%2Fdocusaurus-blank-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniravcodes%2Fdocusaurus-blank-starter/lists"}