From e06b2f27b5db3acd6c8283e68ec067078def20d9 Mon Sep 17 00:00:00 2001 From: Artemy Date: Sun, 24 Dec 2023 18:30:39 +0300 Subject: [PATCH] doc: add summary --- .github/workflows/gh-pages.yml | 29 ++++++++++++++++++++++++ .gitignore | 1 + book.toml | 6 +++++ src/SUMMARY.md | 14 ++++++++++++ src/examples/readme.md | 3 +++ src/specification/readme.md | 1 + src/specification/tokens/brackets.md | 1 + src/specification/tokens/identifiers.md | 1 + src/specification/tokens/keywords.md | 1 + src/specification/tokens/literals.md | 1 + src/specification/tokens/operators.md | 1 + src/specification/tokens/readme.md | 3 +++ src/specification/tokens/token-format.md | 1 + 13 files changed, 63 insertions(+) create mode 100644 .github/workflows/gh-pages.yml create mode 100644 .gitignore create mode 100644 book.toml create mode 100644 src/SUMMARY.md create mode 100644 src/examples/readme.md create mode 100644 src/specification/readme.md create mode 100644 src/specification/tokens/brackets.md create mode 100644 src/specification/tokens/identifiers.md create mode 100644 src/specification/tokens/keywords.md create mode 100644 src/specification/tokens/literals.md create mode 100644 src/specification/tokens/operators.md create mode 100644 src/specification/tokens/readme.md create mode 100644 src/specification/tokens/token-format.md diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..e9763b5 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +book diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..34f0c68 --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["artegoser"] +language = "en" +multilingual = false +src = "src" +title = "SymboScript book" diff --git a/src/SUMMARY.md b/src/SUMMARY.md new file mode 100644 index 0000000..7916648 --- /dev/null +++ b/src/SUMMARY.md @@ -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) diff --git a/src/examples/readme.md b/src/examples/readme.md new file mode 100644 index 0000000..0a8e491 --- /dev/null +++ b/src/examples/readme.md @@ -0,0 +1,3 @@ +# Examples + +This is chapter about how the code in SymboScript looks. diff --git a/src/specification/readme.md b/src/specification/readme.md new file mode 100644 index 0000000..33e6104 --- /dev/null +++ b/src/specification/readme.md @@ -0,0 +1 @@ +# Specification diff --git a/src/specification/tokens/brackets.md b/src/specification/tokens/brackets.md new file mode 100644 index 0000000..31849ac --- /dev/null +++ b/src/specification/tokens/brackets.md @@ -0,0 +1 @@ +# Brackets diff --git a/src/specification/tokens/identifiers.md b/src/specification/tokens/identifiers.md new file mode 100644 index 0000000..326718a --- /dev/null +++ b/src/specification/tokens/identifiers.md @@ -0,0 +1 @@ +# Identifiers diff --git a/src/specification/tokens/keywords.md b/src/specification/tokens/keywords.md new file mode 100644 index 0000000..21be43d --- /dev/null +++ b/src/specification/tokens/keywords.md @@ -0,0 +1 @@ +# Keywords diff --git a/src/specification/tokens/literals.md b/src/specification/tokens/literals.md new file mode 100644 index 0000000..d92e828 --- /dev/null +++ b/src/specification/tokens/literals.md @@ -0,0 +1 @@ +# Literals diff --git a/src/specification/tokens/operators.md b/src/specification/tokens/operators.md new file mode 100644 index 0000000..0d12c6d --- /dev/null +++ b/src/specification/tokens/operators.md @@ -0,0 +1 @@ +# Operators diff --git a/src/specification/tokens/readme.md b/src/specification/tokens/readme.md new file mode 100644 index 0000000..2952258 --- /dev/null +++ b/src/specification/tokens/readme.md @@ -0,0 +1,3 @@ +# Tokens + +This chapter describes the tokens specification. All of the tokens in the design are described in this section. diff --git a/src/specification/tokens/token-format.md b/src/specification/tokens/token-format.md new file mode 100644 index 0000000..01fe992 --- /dev/null +++ b/src/specification/tokens/token-format.md @@ -0,0 +1 @@ +# Token format