Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(v2): fix syntax highlighting for YML code blocks #1988

Merged
merged 1 commit into from
Nov 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions website/docs/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To publish in the blog, create a file within the blog directory with a formatted

For example, at `my-website/blog/2019-09-05-hello-docusaurus-v2.md`:

```md
```yml
---
title: Welcome Docusaurus v2
author: Dattatreya Tripathy
Expand All @@ -32,7 +32,6 @@ authorURL: https://github.com/dt97
authorTwitter: CuriousDT
tags: [hello, docusaurus-v2]
---

Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).

<!--truncate-->
Expand All @@ -56,11 +55,10 @@ The only required field is `title`; however, we provide options to add author in

Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `<!--truncate-->` will be part of the summary. For example:

```md {9}
```yml
---
title: Truncation Example
---

All this will be part of the blog post summary.

Even this.
Expand Down Expand Up @@ -101,7 +99,7 @@ module.exports = {
blog: {
feedOptions: {
type: 'all',
copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`
copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`,
},
},
},
Expand Down
4 changes: 2 additions & 2 deletions website/docs/markdown-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ website # root directory of your site

In the top of the file, specify `id` the `title` in the front matter, so that Docusaurus will pick them up correctly when generating your site.

```markdown
```yml
---
id: greeting
title: Hello
Expand Down Expand Up @@ -107,7 +107,7 @@ Documents use the following markdown header fields that are enclosed by a line `

Example:

```md
```yml
---
id: doc-markdown
title: Markdown Features
Expand Down
3 changes: 1 addition & 2 deletions website/docs/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,10 @@ website # root directory of your site

However, the last part of the `id` can be defined by user in the frontmatter. For example, if `guide/hello.md` content is defined as below, it's final `id` is `guide/part1`.

```md
```yml
---
id: part1
---

Lorem ipsum
```

Expand Down