Skip to content

Commit

Permalink
fix: Consistently set console infostring
Browse files Browse the repository at this point in the history
  • Loading branch information
epage committed Jul 5, 2024
1 parent c0ab19e commit c998f21
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Alternatively, if you are using Markdown, you can [annotate your code
blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting).

To see what syntaxes are supported:
```
```console
$ cobalt debug highlight syntaxes
```

To add support for additional syntaxes you can add a `_syntaxes/` directory to the project root and include in this directory a
[Sublime Text syntax definition](http://www.sublimetext.com/docs/syntax.html#include-syntax) file each syntax.

The theme is taken from your [`_cobalt.yml`](/docs/config). To see the list of supported themes:
```
```console
$ cobalt debug highlight themes
```
10 changes: 5 additions & 5 deletions docs/trouble.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ data:
## Troubleshooting

Every command supports logging additional detail that can be useful when troubleshooting cobalt. For example:
```sh
```console
$ cobalt build --log-level=debug # Show some additional context

$ cobalt build --trace # Show everything
Expand All @@ -17,12 +17,12 @@ $ cobalt build --log-level=trace # Same as above
### Useful commands

Show config after processing defaults, etc:
```sh
```console
$ cobalt debug config
```

Show all files for a given collection:
```sh
```console
$ cobalt debug files pages
$ cobalt debug files posts
$ cobalt debug files posts --draft
Expand All @@ -36,11 +36,11 @@ $ cobalt debug files assets --trace
- etc

Supported code highlight themes:
```sh
```console
$ cobalt debug highlight themes
```

Supported code highlight language syntaxes:
```sh
```console
$ cobalt debug highlight syntaxes
```
28 changes: 14 additions & 14 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ data:
### init

Create a site with an example pages, posts, and layouts:
```
# Create site in current directory
```console
$ # Create site in current directory
$ cobalt init
# Create site in `myBlog` sub-directory
$ # Create site in `myBlog` sub-directory
$ cobalt init myBlog
```

### serve

Serve your site at `127.0.0.1:3000`
```
```console
$ cobalt serve
# Include drafts
$ # Include drafts
$ cobalt serve --drafts
```
This provides live reload; it will re-generate your site as you add or change content.
Expand All @@ -33,12 +33,12 @@ number (default: 3000).
### new

Add a new page or post to your site:
```
# Creates page `cats-around-the-world.md` in the current directory
```console
$ # Creates page `cats-around-the-world.md` in the current directory
$ cobalt new "Cats Around the World"
# Creates post `cats-around-the-world.md` in the `posts` directory
$ # Creates post `cats-around-the-world.md` in the `posts` directory
$ cobalt new "Cats Around the World" --file posts
# Creates post `cats.md` in the `posts` directory
$ # Creates post `cats.md` in the `posts` directory
$ cobalt new "Cats Around the World" --file posts/cats.md
```

Expand All @@ -47,14 +47,14 @@ You can modify the template used for `new` by editing the files in [`_defaults`]
### publish

Once your post is ready, you can publish it:
```
```console
$ cobalt publish posts/cats-around-the-world.md
```

The page will no longer be a "draft" and the `published_date` will be set to today.

You can also publish from the `drafts` folder:
```
```console
$ cobalt publish drafts/dogs-around-the-world.md
```

Expand All @@ -70,7 +70,7 @@ Once the states of your documents are in a position to be put online − by usin
`publish` on the documents you want to make visible, or manually setting
`is_draft: false` − it's time to build the website:

```
```console
$ cobalt build
```

Expand All @@ -90,11 +90,11 @@ further details.
### More

To see all the available commands, run
```
```console
$ cobalt --help
```

You can then get help with those commands by running
```
```console
$ cobalt <command> --help
```
14 changes: 7 additions & 7 deletions getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Download a [release](https://github.com/cobalt-org/cobalt.rs/releases).

or

```
```console
$ curl -LSfs https://raw.githubusercontent.com/crate-ci/gh-install/master/v1/install.sh | sh -s -- --git cobalt-org/cobalt.rs --crate cobalt
```

Expand All @@ -18,23 +18,23 @@ $ curl -LSfs https://raw.githubusercontent.com/crate-ci/gh-install/master/v1/ins
#### Start

Create a site with an example pages, posts, and layouts:
```
```console
$ mkdir myBlog && cd myBlog
$ cobalt init
```

#### Preview

Serve your site at `127.0.0.1:3000`
```
```console
$ cobalt serve
```
This provides live reload; it will re-generate your site as you add or change content.

#### Add a Page

Add a new page or post to your site:
```
```console
$ cobalt new "Cats Around the World"
```

Expand All @@ -43,14 +43,14 @@ The type of file created is based on which directory you put it in.

Posts start out as "drafts". For them to show up on `serve`, you'll need to
pass the `--drafts` flag:
```
```console
$ cobalt serve --drafts
```

#### Publish a Post

Once your post is ready, you can publish it:
```
```console
$ cobalt publish posts/cats-around-the-world.md
```

Expand All @@ -59,7 +59,7 @@ The page will no longer be a "draft" and the `published_date` will be set to tod
#### Build the site

Once the post is in published state, build the site:
```
```console
$ cobalt build
```

Expand Down

0 comments on commit c998f21

Please sign in to comment.