Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GeopJr/SveltePress
Documentation for humans.
https://github.com/GeopJr/SveltePress
documentation hacktoberfest svelte sveltekit sveltepress
Last synced: about 2 months ago
JSON representation
Documentation for humans.
- Host: GitHub
- URL: https://github.com/GeopJr/SveltePress
- Owner: GeopJr
- License: unlicense
- Archived: true
- Created: 2021-07-09T21:21:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-29T22:27:45.000Z (over 2 years ago)
- Last Synced: 2024-10-19T06:37:52.377Z (2 months ago)
- Topics: documentation, hacktoberfest, svelte, sveltekit, sveltepress
- Language: Svelte
- Homepage: https://sveltepress.geopjr.dev/
- Size: 1.24 MB
- Stars: 218
- Watchers: 2
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-svelte-kit - SveltePress - documentation tool built on top of SvelteKit, (📦 Built With Svelte / Open-Source Projects)
README
Looking for a better alternative? Check out KitDocs!
#
Project is EOL
#
SveltePress
Documentation for humans.
#
## What is SveltePress?
SveltePress 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/).
SvelteKit & 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.
Apart from all the super powers inherited from Svelte & 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.
For example the following structure...
```bash
pages
└── cooking
├── allergies.md
├── main_dish
│  ├── pizza.md
│  └── spaghetti.md
└── readme.md
```
will generate the following sidebar:
```md
- Cooking
- Allergies
- Main Dish
- Pizza
- Spaghetti
```
#
## Installation
The 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.
```bash
# Replace `my-sveltepress-project` with the name you desire
npx degit GeopJr/SveltePress my-sveltepress-project
# or by using create-sveltepress-app (which wraps the above)
npx create-sveltepress-app create my-sveltepress-project
# Change directory to the folder from the previous step
cd my-sveltepress-project
# Install dependencies
# PNPM is recommended but both YARN and NPM will do
pnpm install
# A post-install script will now create some symlinks
```
#### On Windows (non-WSL), creating symlinks requires Admin Privileges, the script will ask you to re-run it in an Admin terminal.
> For more info on how SveltePress works, how to set it up & more, visit [https://sveltepress.geopjr.dev/](https://sveltepress.geopjr.dev/)
#
## Themes
There's not a curated theme gallery, but any repo will do.
Themes are being handled by `create-sveltepress-app`:
```bash
# Create a new SveltePress with the cakepop theme
npx create-sveltepress-app create my-sveltepress-project --theme=GeopJr/cakepop
# Or replace your current theme with cakepop (assumes you are at the root of your Sveltepress project)
npx create-sveltepress-app add --theme=GeopJr/cakepop
# Or restore to the default theme
npx create-sveltepress-app add --theme=GeopJr/SveltePress/src/lib/SveltePress/theme/
```
The `--theme` argument accepts anything degit handles (including branches, folders, tags etc.).
[cakepop](https://github.com/GeopJr/cakepop) is an 'official' theme using Windi CSS.
#
## GUI
SveltePress can create native GUIs for Android, iOS, Linux, macOS & Windows automatically! Visit the [/gui folder](https://github.com/GeopJr/SveltePress/tree/main/gui) for more info!
#
## Pandoc
SveltePress 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!
#
#
## Video Docs
#
## Contributing
1. Read the [Code of Conduct](https://github.com/GeopJr/SveltePress/blob/main/CODE_OF_CONDUCT.md)
2. Fork it ( https://github.com/GeopJr/SveltePress/fork )
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request
#
## Sponsors
[](https://github.com/sponsors/GeopJr)