Skip to content

Commit

Permalink
docs: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
johnfraney committed Jan 3, 2025
1 parent a028132 commit 0553189
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 7 deletions.
3 changes: 3 additions & 0 deletions docs/content/commands/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
name = "Commands: build"
abstract = "Documentation for Blurry's build command"
datePublished = 2023-04-09
dateModified = 2024-01-03
+++

# Commands: build

## Usage

`build` builds a production-ready version of a Blurry static site.
It outputs the site in the folder specified by the `build_directory_name` [setting](./../configuration/settings.md), which defaults to `./dist/`

Expand Down
29 changes: 23 additions & 6 deletions docs/content/commands/runserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
name = "Commands: runserver"
abstract = "Documentation for Blurry's runserver command"
datePublished = 2023-04-09
dateModified = 2024-01-03
+++

# Commands: `runserver`

## Usage

This command is a nod to [Django's command of the same name](https://docs.djangoproject.com/en/latest/ref/django-admin/#runserver).
It starts a development server on `http://127.0.0.1:8000` and live-reloads when source content changes.

Expand All @@ -15,13 +18,27 @@ It starts a development server on `http://127.0.0.1:8000` and live-reloads when
- It is served on `f"http://{DEV_HOST}:{DEV_PORT}"`, which defaults to <http://127.0.0.1:8000/> and can be changed in the [settings](../configuration/settings.md)
- The `RUNSERVER` setting is set to `True`, which can be useful in conditionally rendering analytics or ad tags in [templates](../templates/syntax.md)

Its output looks something like:
## Example

`runserver`'s output looks something like:

```shell
$ blurry runserver
[I 230108 15:47:36 server:335] Serving on http://127.0.0.1:8000
[I 230108 15:47:36 handlers:62] Start watching changes
[I 230108 15:47:36 handlers:64] Start detecting changes
Gathered 14 tasks (sitemap and 13 content files)
Took 0.119001 seconds
. .
|-.| . ..-..-.. .
`-''-'-'' ' '-|
`-'
┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Markdown Plugins ┃ HTML Plugins ┃ Jinja Plugins ┃
┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ container │ minify_html │ body_to_cards │
│ punctuation │ │ headings │
│ python_code │ │ url_path │
│ python_code_in_list │ │ blurry_image │
└─────────────────────┴──────────────┴───────────────┘
[I 250103 10:41:51 server:331] Serving on http://127.0.0.1:8000
[I 250103 10:41:51 handlers:62] Start watching changes
[I 250103 10:41:51 handlers:64] Start detecting changes
Blurring 21 Markdown files and 6 other files
Built site in 2.465286 seconds
```
4 changes: 3 additions & 1 deletion docs/content/plugins/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
name = "Plugins: intro"
abstract = "Documentation for Blurry's plugin architecture"
datePublished = 2023-04-15
dateModified = 2024-01-03
+++

# Plugins: intro

:::{info}
This documentation covers how to write and register Blurry plugins.
For documentation about custom Mistune plugins that Blurry ships with out-of-the-box, see [Content: Markdown](../content/markdown.md).
For documentation about custom [Mistune](https://mistune.lepture.com/en/latest/) plugins that Blurry ships with out-of-the-box, see [Content: Markdown](../content/markdown.md).
:::

Blurry ships with a simple plugin infrastructure that makes it easy to write and register plugins that change how Blurry processes Markdown and HTML.
Expand All @@ -21,6 +22,7 @@ See the docs for the type of plugin you'd like to write:
- [Plugins: write a Markdown plugin](./write-a-markdown-plugin.md)
- [Plugins: write an HTML plugin](./write-an-html-plugin.md)
- [Plugins: write a Jinja filter plugin](./write-a-jinja-filter-plugin.md)
- [Plugins: write a Jinja extension plugin](./write-a-jinja-extension-plugin.md)

## How to register a plugin

Expand Down

0 comments on commit 0553189

Please sign in to comment.