https://github.com/kyori19/write-with-satysfi

A template repository to write docs with SATySFi.
https://github.com/kyori19/write-with-satysfi

satysfi

Last synced: 6 days ago
JSON representation

A template repository to write docs with SATySFi.

• Host: GitHub
• URL: https://github.com/kyori19/write-with-satysfi
• Owner: kyori19
• License: mit
• Created: 2023-07-18T02:34:42.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-12T09:57:37.000Z (over 1 year ago)
• Last Synced: 2024-11-17T21:41:21.980Z (2 months ago)
• Topics: satysfi
• Language: Shell
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Write with SATySFi

A template repository to write docs with [SATySFi](https://github.com/gfngfn/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](https://github.com/new?template_name=write-with-satysfi&template_owner=kyori19) (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](https://docs.github.com/en/codespaces/prebuilding-your-codespaces/configuring-prebuilds).

### 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](https://github.com/kyori19/write-with-satysfi/discussions)!