{"id":13484882,"url":"https://github.com/GeopJr/SveltePress","last_synced_at":"2025-03-27T16:31:32.355Z","repository":{"id":40660353,"uuid":"384553481","full_name":"GeopJr/SveltePress","owner":"GeopJr","description":"Documentation for humans.","archived":true,"fork":false,"pushed_at":"2022-04-29T22:27:45.000Z","size":1303,"stargazers_count":218,"open_issues_count":8,"forks_count":15,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-15T12:45:47.995Z","etag":null,"topics":["documentation","hacktoberfest","svelte","sveltekit","sveltepress"],"latest_commit_sha":null,"homepage":"https://sveltepress.geopjr.dev/","language":"Svelte","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GeopJr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-09T21:21:54.000Z","updated_at":"2024-11-21T20:54:56.000Z","dependencies_parsed_at":"2022-08-10T00:10:52.992Z","dependency_job_id":null,"html_url":"https://github.com/GeopJr/SveltePress","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2FSveltePress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2FSveltePress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2FSveltePress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeopJr%2FSveltePress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeopJr","download_url":"https://codeload.github.com/GeopJr/SveltePress/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245882438,"owners_count":20687889,"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","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":["documentation","hacktoberfest","svelte","sveltekit","sveltepress"],"created_at":"2024-07-31T17:01:37.520Z","updated_at":"2025-03-27T16:31:31.729Z","avatar_url":"https://github.com/GeopJr.png","language":"Svelte","funding_links":["https://github.com/sponsors/GeopJr"],"categories":["Svelte","📦 Built With Svelte"],"sub_categories":["Open-Source Projects"],"readme":"\u003ch3 align=\"center\"\u003eLooking for a better alternative? Check out \u003ca href=\"https://github.com/svelteness/kit-docs\"\u003eKitDocs\u003c/a\u003e!\u003c/h3\u003e\n\n#\n\n\u003ch2 align=\"center\"\u003e\u003ca href=\"https://github.com/GeopJr/SveltePress/issues/533\"\u003eProject is EOL\u003c/a\u003e\u003c/h2\u003e\n\n#\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"SveltePress branding\" src=\"https://i.imgur.com/k0MgzIl.png\"\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eSveltePress\u003c/h1\u003e\n\u003ch4 align=\"center\"\u003eDocumentation for humans.\u003c/h4\u003e\n\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\n    \u003ca href=\"https://github.com/GeopJr/SveltePress/blob/main/CODE_OF_CONDUCT.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/Contributor%20Covenant-v2.1-ff3e00.svg?style=for-the-badge\u0026labelColor=ffd0bf\" alt=\"Code Of Conduct\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/GeopJr/SveltePress/blob/main/UNLICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/LICENSE-UNLICENSE-ff3e00.svg?style=for-the-badge\u0026labelColor=ffd0bf\" alt=\"UNLICENSE\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n#\n\n## What is SveltePress?\n\nSveltePress is a documentation tool built on top of [SvelteKit](https://kit.svelte.dev/), a \"serverless-first\" framework for building web applications for [Svelte](https://svelte.dev/).\n\nSvelteKit \u0026 Svelte's simplicity allow the user to modify SveltePress to fit their needs with little to no effort while taking advantage of the incredible performance of both of them.\n\nApart from all the super powers inherited from Svelte \u0026 SvelteKit, the main point of SveltePress is to allow less knowledgeable users to create and publish content. To achieve that, SveltePress uses a filesystem-based structure.\n\nFor example the following structure...\n\n```bash\npages\n└── cooking\n    ├── allergies.md\n    ├── main_dish\n    │   ├── pizza.md\n    │   └── spaghetti.md\n    └── readme.md\n```\n\nwill generate the following sidebar:\n\n```md\n- Cooking\n- Allergies\n- Main Dish\n  - Pizza\n  - Spaghetti\n```\n\n#\n\n## Installation\n\nThe best way to install SveltePress is by using [degit](https://github.com/Rich-Harris/degit). degit works similarly to git but uses only the latest commit (plus can be configured to delete some files), you can read more about it on its repo page.\n\n```bash\n# Replace `my-sveltepress-project` with the name you desire\nnpx degit GeopJr/SveltePress my-sveltepress-project\n# or by using create-sveltepress-app (which wraps the above)\nnpx create-sveltepress-app create my-sveltepress-project\n\n# Change directory to the folder from the previous step\ncd my-sveltepress-project\n\n# Install dependencies\n# PNPM is recommended but both YARN and NPM will do\npnpm install\n\n# A post-install script will now create some symlinks\n```\n\n#### On Windows (non-WSL), creating symlinks requires Admin Privileges, the script will ask you to re-run it in an Admin terminal.\n\n\u003e For more info on how SveltePress works, how to set it up \u0026 more, visit [https://sveltepress.geopjr.dev/](https://sveltepress.geopjr.dev/)\n\n#\n\n## Themes\n\nThere's not a curated theme gallery, but any repo will do.\nThemes are being handled by `create-sveltepress-app`:\n\n```bash\n# Create a new SveltePress with the cakepop theme\nnpx create-sveltepress-app create my-sveltepress-project --theme=GeopJr/cakepop\n\n# Or replace your current theme with cakepop (assumes you are at the root of your Sveltepress project)\nnpx create-sveltepress-app add --theme=GeopJr/cakepop\n\n# Or restore to the default theme\nnpx create-sveltepress-app add --theme=GeopJr/SveltePress/src/lib/SveltePress/theme/\n```\n\nThe `--theme` argument accepts anything degit handles (including branches, folders, tags etc.).\n\n[cakepop](https://github.com/GeopJr/cakepop) is an 'official' theme using Windi CSS.\n\n#\n\n## GUI\n\nSveltePress can create native GUIs for Android, iOS, Linux, macOS \u0026 Windows automatically! Visit the [/gui folder](https://github.com/GeopJr/SveltePress/tree/main/gui) for more info!\n\n#\n\n## Pandoc\n\nSveltePress can export to epub, pdf, docx [and a whole lot more formats using Pandoc](https://pandoc.org/). Visit the [/pandoc folder](https://github.com/GeopJr/SveltePress/tree/main/pandoc) for more info!\n\n#\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"diagram of filesystem and the coresponding sidebar\" src=\"https://i.imgur.com/nD87FA2.png\"\u003e\n\u003c/p\u003e\n\n#\n\n## Video Docs\n\n\u003ca href=\"https://www.youtube.com/watch?v=P23AeugwIFo\u0026list=PLahj1xcdBwiHRLLS3ZPUoPLVNz6Fh3SnH\"\u003e\n  \u003cimg width=\"512\" alt=\"youtube video\" src=\"https://img.youtube.com/vi/P23AeugwIFo/maxresdefault.jpg\" /\u003e\n\u003c/a\u003e\n\n#\n\n## Contributing\n\n1. Read the [Code of Conduct](https://github.com/GeopJr/SveltePress/blob/main/CODE_OF_CONDUCT.md)\n2. Fork it ( https://github.com/GeopJr/SveltePress/fork )\n3. Create your feature branch (git checkout -b my-new-feature)\n4. Commit your changes (git commit -am 'Add some feature')\n5. Push to the branch (git push origin my-new-feature)\n6. Create a new Pull Request\n\n#\n\n## Sponsors\n\n\u003cp align=\"center\"\u003e\n\n  [![GeopJr Sponsors](https://cdn.jsdelivr.net/gh/GeopJr/GeopJr@main/sponsors.svg)](https://github.com/sponsors/GeopJr)\n\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGeopJr%2FSveltePress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGeopJr%2FSveltePress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGeopJr%2FSveltePress/lists"}