minor edits and add workflow

Author: jhidding

.github/workflows/pages.yml

@@ -0,0 +1,63 @@
+# This is a basic workflow to help you get started with Actions
+
+name: build pages
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run MkDocs
+        run: uv run mkdocs build
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: "site"
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/git.md

@@ -19,6 +19,7 @@ git add .
 git commit -m 'fixed everything'   # save everything you did
 entangled tangle --force           # overwrites some changes you made
 git restore src/brilliant_code.c   # retrieve from latest commit
+touch src/brilliant_code.c         # set modification time of the file
 entangled stitch                   # apply changes back to markdown
 git add .
 git commit --amend                 # amend your commit to perfection

docs/index.md

@@ -1,5 +1,7 @@
 # Welcome to Entangled
 ![PyPI - Version](https://img.shields.io/pypi/v/entangled-cli)
+[![Upload Python Package](https://github.com/entangled/entangled.py/actions/workflows/deploy.yml/badge.svg)](https://github.com/entangled/entangled.py/actions/workflows/deploy.yml)
+[![Python package](https://github.com/entangled/entangled.py/actions/workflows/python-package.yml/badge.svg)](https://github.com/entangled/entangled.py/actions/workflows/python-package.yml)
 
 **Entangled** lets you write code and proze in a single document. It extracts working source code from your documentation, and keeps the documentation and source code mutualy synchronized. Entangled works with any programming language and supports a wide variety of markup languages, principally most dialects of Markdown.
 

docs/markup.md

@@ -10,7 +10,8 @@ tags:
 
 # Document Markup Languages
 
-The default setting is to use attributes enclosed in curly braces. This offers a relatively noise-free syntax for denoting code blocks, their labels and file targets. However, not all document generators understand this syntax.
+The default setting is to use attributes enclosed in curly braces. This offers a relatively noise-free syntax for denoting code blocks, their labels and file targets. However, not all document generators understand this syntax. 
+
 
 ## Vanilla (Github flavoured) Markdown and Typst
 
@@ -37,7 +38,6 @@ if __name__ == "__main__":
 This needs the following `entangled.toml`:
 
 ```toml
-#| file: entangled.toml
 version="2.0"
 hooks=["quarto_attributes"]
 
@@ -46,6 +46,13 @@ open="^(?P<indent>\\s*)```(?P<properties>.*)$"
 close="^(?P<indent>\\s*)```\\s*$"
 ```
 
+Or, use the `basic` style setting to the same effect:
+
+```toml
+version="2.4"
+style="basic"
+```
+
 ## Not yet implemented: Restructured Text
 
 Restructured text is quite different from Markdown. The following needs an additional hook to parse the attribute section: