Write with SATySFi

A template repository to write docs with SATySFi.

SATySFi (pronounced in the same way as the verb “satisfy” in English) is a new typesetting system equipped with a statically-typed, functional programming language.

Usage

Before you start writing, PLEASE REMOVE OR CHANGE LICENSE FILE.

Use as Template Repository (recommended)

1. Create a new repository from this template by clicking this link (or click Use this template > Create a new repository)
2. Open GitHub Codespaces by clicking Code > Create codespace on master
3. (optional) Add dependencies to your .devcontainer/on-create.sh
4. Rebuild Container from Codespaces menu or use Codespaces: Rebuild Container from command palette
5. Place your files to the repository
6. Run SATySFi from terminal or VSCode extension

If you want to speed up container startup time, you can configure prebuild for the repository.

Use as DevContainer Template

This option is suitable for users of different Git providers, or no-VCS project.

1. Open this repository in Codespaces by clicking Use this template > Open in a codespace
2. (optional) Generate a new SSH key and configure your Git provider
3. (optional) Add dependencies to your .devcontainer/on-create.sh
4. Rebuild Container from Codespaces menu or use Codespaces: Rebuild Container from command palette
5. Place your files to the repository
6. Run SATySFi from terminal or VSCode extension

Contribution

Have an ideas?

Please write new discussion!