https://github.com/skriptlang/skript-docs

Documentation Site for Skript Plugin
https://github.com/skriptlang/skript-docs

docs documentation skript

Last synced: 27 days ago
JSON representation

Documentation Site for Skript Plugin

• Host: GitHub
• URL: https://github.com/skriptlang/skript-docs
• Owner: SkriptLang
• License: gpl-3.0
• Created: 2023-01-20T19:53:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-05-01T19:43:27.000Z (about 1 month ago)
• Last Synced: 2025-05-11T00:54:56.280Z (28 days ago)
• Topics: docs, documentation, skript
• Homepage: https://docs.skriptlang.org/
• Size: 247 MB
• Stars: 3
• Watchers: 4
• Forks: 12
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Skript Docs](.github/assets/cover.jpg)

---

# Skript Documentation Site

Skript's features are documented directly in it's Java code. But we still need

1. Clear tutorials, not just "you can check the syntax pattern"

2. Examples explained, if needed

3. Addon tutorials

4. Syntax patterns explained

## Folders Structure

- `docs/templates/` is used by Skript Docs generation process to produce the docs pages (`docs/`).

- `docs/` is the production files where Github pages displays the content of.

- `docs/nightly/master/` is Skript's nightly builds documentation pages (this gets updated with every commit to master/dev branches in [Skript's repo](https://github.com/SkriptLang/skript)).

You can find more about the docs templates in [docs/templates](docs/templates/README.md).

## Generating the documentation

Currently, the docs files is generated using Skript plugin.

1. You will need to create a directory named `docs/templates` in `plugins/Skript/`, and copy everything from [docs/templates folder](docs/templates) into that directory.

2. Execute the command `/sk gen-docs`.

3. The `docs/` directory will be created _(if not created already)_ in `plugins/Skript` containing the website's files.

4. Open `index.html` and browse the documentation.

5. _(Optionally)_ Add this system property `-Dskript.forceregisterhooks` in your server startup script (before the -jar property) to force generating hooks docs.