doc: add summary

This commit is contained in:
Artemy 2023-12-24 18:30:39 +03:00
parent 6f2d75e72e
commit e06b2f27b5
13 changed files with 63 additions and 0 deletions

29
.github/workflows/gh-pages.yml vendored Normal file
View file

@ -0,0 +1,29 @@
name: github pages
on:
push:
branches:
- main
pull_request:
jobs:
deploy:
runs-on: ubuntu-20.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v2
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: "latest"
- run: mdbook build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
book

6
book.toml Normal file
View file

@ -0,0 +1,6 @@
[book]
authors = ["artegoser"]
language = "en"
multilingual = false
src = "src"
title = "SymboScript book"

14
src/SUMMARY.md Normal file
View file

@ -0,0 +1,14 @@
# Summary
- [Specification](specification/readme.md)
- [Tokens](specification/tokens/readme.md)
- [Token format](specification/tokens/token-format.md)
- [Operators](specification/tokens/operators.md)
- [Keywords](specification/tokens/keywords.md)
- [Identifiers](specification/tokens/identifiers.md)
- [Literals](specification/tokens/literals.md)
- [Brackets](specification/tokens/brackets.md)
- [Examples](examples/readme.md)

3
src/examples/readme.md Normal file
View file

@ -0,0 +1,3 @@
# Examples
This is chapter about how the code in SymboScript looks.

View file

@ -0,0 +1 @@
# Specification

View file

@ -0,0 +1 @@
# Brackets

View file

@ -0,0 +1 @@
# Identifiers

View file

@ -0,0 +1 @@
# Keywords

View file

@ -0,0 +1 @@
# Literals

View file

@ -0,0 +1 @@
# Operators

View file

@ -0,0 +1,3 @@
# Tokens
This chapter describes the tokens specification. All of the tokens in the design are described in this section.

View file

@ -0,0 +1 @@
# Token format