Changes for v1.0.0-alpha.1 (#12)

- improved generator
- better context variables & theme support
- custom markdown block directive support
- many other smaller changes
- removed examples (will be moved to separate repository)

---------

Co-authored-by: eNBee <[email protected]>
Co-authored-by: Ferenc Viasz-Kadi <[email protected]>
Co-authored-by: Sipos Andras <[email protected]>
Co-authored-by: Sébastien Stormacq <[email protected]>
Co-authored-by: Joannis Orlandos <[email protected]>

.github/workflows/run-checks.yml

@@ -0,0 +1,26 @@
+name: Run checks
+
+on:
+  pull_request:
+    branches:
+    - main
+
+jobs:
+
+  run-checks:
+    # runs-on: macOS-latest
+    runs-on: self-hosted
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
+
+    - name: Install Dependencies
+      run: |
+        brew install mint
+        mint install NickLockwood/[email protected] --no-link
+    
+    - name: run script
+      run: ./scripts/run-checks.sh

.github/workflows/run-tests.yml

@@ -0,0 +1,56 @@
+name: Run tests
+
+on:
+  push:
+    branches:
+    - main
+    paths:
+    - '**.swift'
+  pull_request:
+    branches:
+    - main
+
+jobs:
+
+  macOS-tests:
+    runs-on: self-hosted
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    # - name: Cache
+    #   uses: actions/cache@v3
+    #   with:
+    #     path: server/.build
+    #     key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
+    #     restore-keys: ${{ runner.os }}-spm-
+
+    - name: Test
+      run: swift test --parallel --enable-code-coverage
+
+  linux-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        image:
+          - 'swift:5.10'
+    container:
+      image: ${{ matrix.image }}
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    # - name: Cache
+    #   uses: actions/cache@v3
+    #   with:
+    #     path: server/.build
+    #     key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
+    #     restore-keys: ${{ runner.os }}-spm-
+
+    - name: Swift version
+      run: swift --version
+
+    - name: Test
+      run: swift test --parallel --enable-code-coverage

.gitignore

@@ -1,4 +1,9 @@
 .DS_Store
 .swiftpm
 .build
-.vscode
+.vscode
+.obsidian
+**/dist
+**/docs
+Tests/sites/benchmark/
+Examples/try-o/

.swift-format

@@ -13,7 +13,7 @@
   "lineBreakBeforeEachGenericRequirement" : true,
   "lineLength" : 80,
   "maximumBlankLines" : 1,
-  "prioritizeKeepingFunctionOutputTogether" : false,
+  "prioritizeKeepingFunctionOutputTogether" : true,
   "respectsExistingLineBreaks" : true,
   "rules" : {
     "AllPublicDeclarationsHaveDocumentation" : true,

LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2018-2022 Tibor Bödecs
+Copyright (c) 2022-2024 Binary Birds Ltd.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -1,26 +1,29 @@
+SHELL=/bin/bash
+
 build:
 	swift build
 
-update:
-	swift package update
-
 release:
 	swift build -c release
 
 test:
 	swift test --parallel
 
+test-with-coverage:
+	swift test --parallel --enable-code-coverage
+
 clean:
 	rm -rf .build
 
-install: release
-	install ./.build/release/toucan /usr/local/bin/toucan
-
-uninstall:
-	rm /usr/local/bin/toucan
+check:
+	./scripts/run-checks.sh
 
 format:
-	swift-format -i -r ./Sources && swift-format -i -r ./Tests
+	./scripts/run-swift-format.sh --fix
+
+install:
+	./scripts/install-toucan.sh
+
+uninstall:
+	./scripts/uninstall-toucan.sh
 
-lint:
-	swift-format lint -r ./Sources && swift-format lint -r ./Tests