Skip to content

Commit

Permalink
Run all terminal output through gluegun
Browse files Browse the repository at this point in the history
  • Loading branch information
irskep committed Aug 29, 2024
1 parent 06c2266 commit c7566c8
Show file tree
Hide file tree
Showing 27 changed files with 1,584 additions and 335 deletions.
Binary file modified bun.lockb
Binary file not shown.
11 changes: 6 additions & 5 deletions docs/out/gfm/basics/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
DO NOT EDIT THIS FILE DIRECTLY!
It is generated by djockey.
-->

- [Deploying](../basics/deploying.md#Deploying)
- [GitHub Pages](../basics/deploying.md#GitHub-Pages)

Expand All @@ -17,7 +16,7 @@
Deploying a Djockey site is the same as any other static site generator.
But for your convenience, here is a GitHub Actions workflow:

```yaml
``` yaml
name: Deploy static content to Pages

on:
Expand Down Expand Up @@ -61,12 +60,14 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

```

</div>

</div>

| Previous | Next |
| --------------------------------------- | ----------------------------------------------------- |
| [Using Markdown](../basics/markdown.md) | [Configuration reference](../basics/configuration.md) |

| Previous | Next |
| - | - |
| [Using Markdown](../basics/markdown.md) | [Configuration reference](../basics/configuration.md) |
14 changes: 7 additions & 7 deletions docs/out/gfm/basics/djockey_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@
DO NOT EDIT THIS FILE DIRECTLY!
It is generated by djockey.
-->

- [The `djockey`
command](../basics/djockey_command.md#The-djockey-command)

<div id="The-djockey-command" class="section" id="The-djockey-command">

# The `djockey` command

`djockey <path-to-docs>` will output HTML by default. To output
GitHub Flavored Markdown instead, pass `--output-format=gfm`.
`djockey <path-to-docs>` will output HTML by default. To output GitHub
Flavored Markdown instead, pass `--output-format=gfm`.

```text
``` text
usage: djockey [-h] [--local] [-f {html,gfm}] input
positional arguments:
Expand All @@ -27,6 +26,7 @@ optional arguments:

</div>

| Previous | Next |
| --------------------------------------------- | ---------------------------------------- |
| [Alternatives to Djockey](../alternatives.md) | [Front matter](../basics/frontmatter.md) |

| Previous | Next |
| - | - |
| [Alternatives to Djockey](../alternatives.md) | [Front matter](../basics/frontmatter.md) |
1 change: 1 addition & 0 deletions docs/out/gfm/contributing/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Dependencies supporting the core functionality of Djockey:
- [Nunjucks](https://mozilla.github.io/nunjucks/): String templates
- [parse5](https://www.npmjs.com/package/parse5): Spec-compliant HTML5
parsing
- [gluegun](https://github.com/infinitered/gluegun): Command line output

Dependencies supporting individual features:

Expand Down
12 changes: 6 additions & 6 deletions docs/out/gfm/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
DO NOT EDIT THIS FILE DIRECTLY!
It is generated by djockey.
-->

- [Getting Started](./getting_started.md#Getting-Started)
- [Building for local viewing vs
deployment](./getting_started.md#Building-for-local-viewing-vs-deployment)
Expand All @@ -14,7 +13,7 @@
Once you’ve [installed Djockey](./installation.md#Installation), create
a file called `djockey.yaml` that looks like this:

```yaml
``` yaml
input_dir: path-to-your-docs
output_dir:
html: docs_out/html
Expand All @@ -41,14 +40,15 @@ site without a web server and some edits to `/etc/hosts`.
To have Djockey use file URLs instead, only valid on your own machine
and not requiring a web server, pass `--local`.

```sh
``` sh
djockey my_docs_dir --local
```

</div>

</div>

| Previous | Next |
| --------------------------------- | ---------------------------------- |
| [Installation](./installation.md) | [Why Djockey? Why Djot?](./why.md) |

| Previous | Next |
| - | - |
| [Installation](./installation.md) | [Why Djockey? Why Djot?](./why.md) |
2 changes: 1 addition & 1 deletion docs/src/contributing/dependencies.dj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Dependencies supporting the core functionality of Djockey:
- [micromatch](https://www.npmjs.com/package/micromatch): Apply config file include/exclude patterns (already a sub-dependency of `fast-glob`{.language-sh})
- [Nunjucks](https://mozilla.github.io/nunjucks/): String templates
- [parse5](https://www.npmjs.com/package/parse5): Spec-compliant HTML5 parsing
- [@poppinss/cliui](https://github.com/poppinss/cliui): Command line output
- [gluegun](https://github.com/infinitered/gluegun): Command line output

Dependencies supporting individual features:

Expand Down
Loading

0 comments on commit c7566c8

Please sign in to comment.