Skip to content

Commit

Permalink
Update GFM docs
Browse files Browse the repository at this point in the history
  • Loading branch information
irskep committed Aug 30, 2024
1 parent ff2acb7 commit a73c171
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 19 deletions.
10 changes: 5 additions & 5 deletions docs/out/gfm/basics/asides.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Note

<div class="dj-djot-demo" hlRequestID="26">
<div class="dj-djot-demo" hlRequestID="29">

Input:

Expand All @@ -44,7 +44,7 @@ Objects in mirror may be closer than they appear

## Tip

<div class="dj-djot-demo" hlRequestID="27">
<div class="dj-djot-demo" hlRequestID="30">

Input:

Expand All @@ -71,7 +71,7 @@ Objects in mirror may be closer than they appear

## Important

<div class="dj-djot-demo" hlRequestID="28">
<div class="dj-djot-demo" hlRequestID="31">

Input:

Expand All @@ -98,7 +98,7 @@ Objects in mirror may be closer than they appear

## Caution

<div class="dj-djot-demo" hlRequestID="29">
<div class="dj-djot-demo" hlRequestID="32">

Input:

Expand All @@ -125,7 +125,7 @@ Objects in mirror may be closer than they appear

## Warning

<div class="dj-djot-demo" hlRequestID="30">
<div class="dj-djot-demo" hlRequestID="33">

Input:

Expand Down
2 changes: 1 addition & 1 deletion docs/out/gfm/basics/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Djockey is pre-alpha and config options *will* change.

<div class="version-modified changed-in-version">

Will be changed in version 0.0.5
Changed in version 0.0.5

Config options are now snake case instead of camel case.

Expand Down
28 changes: 26 additions & 2 deletions docs/out/gfm/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
-->
- [Changelog](./changelog.md#Changelog)
- [0.1](./changelog.md#0-1)
- [0.0.1-0.0.5](./changelog.md#0-0-1-0-0-5)
- [0.1.1 - 2024-08-30](./changelog.md#0-1-1---2024-08-30)
- [0.1.0 - 2024-08-29](./changelog.md#0-1-0---2024-08-29)
- [0.0](./changelog.md#0-0)
- [0.0.1-0.0.5](./changelog.md#0-0-1-0-0-5)

<div id="Changelog" class="section" id="Changelog">

Expand All @@ -14,6 +17,19 @@

## 0.1

<div id="0-1-1---2024-08-30" class="section" id="0-1-1---2024-08-30">

### 0.1.1 - 2024-08-30

- Fix tab group font consistency
- Tweak nested list CSS

</div>

<div id="0-1-0---2024-08-29" class="section" id="0-1-0---2024-08-29">

### 0.1.0 - 2024-08-29

- Overhaul logging and error reporting
- Support `.dj` file extension in addition to `.djot`
- Configuration
Expand All @@ -28,16 +44,24 @@

</div>

</div>

<div id="0-0" class="section" id="0-0">

## 0.0

<div id="0-0-1-0-0-5" class="section" id="0-0-1-0-0-5">

## 0.0.1-0.0.5
### 0.0.1-0.0.5

Initial release and working out the kinks.

</div>

</div>

</div>


| Previous | Next |
| - | - |
Expand Down
2 changes: 1 addition & 1 deletion docs/out/gfm/features/syntax_highlighting.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Output: `print("Hello, world")`

<div class="version-modified added-in-version">

Will be added in version 0.0.5
Added in version 0.0.5

</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/out/gfm/features/version_directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<div class="version-modified added-in-version">

Will be added in version 0.0.5
Added in version 0.0.5

</div>

Expand Down
40 changes: 31 additions & 9 deletions docs/out/gfm/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,45 @@
# Installation

I know I promised you a single-binary distribution, but since I haven’t
actually released Djockey yet, you’ll need to download it.
actually released Djockey yet, you’ll need to run it with `npx`:

``` sh
git clone [email protected]:irskep/djockey.git
cd djockey
yarn install
npm link
npx djockey path/to/docs
```

In the future, you’ll be able to run it with `npx`:
or `bunx`:

``` sh
npx djockey docs
bunx djockey path/to/docs
```

Or grab a binary from the [GitHub releases
page](https://github.com/irskep/djockey/releases).
or install it in your JS project and then run it:

<div class="tab-group">

### Node

<div class="dj-tab tabgroup-0 tabgroup-0-tab-0 m-active">

``` sh
npm install djockey
npm run djockey path/to/docs
```

</div>

### Bun

<div class="dj-tab tabgroup-0 tabgroup-0-tab-1 ">

``` sh
bun install djockey
bunx djockey path/to/docs
```

</div>

</div>

<div id="Pandoc" class="section" id="Pandoc">

Expand Down

0 comments on commit a73c171

Please sign in to comment.