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.

Sign up for GitHub

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

fix(create-docusaurus): fix init template code blocks, and little improvements #9696

Merged
merged 3 commits into from
Jan 4, 2024
Merged

fix(create-docusaurus): fix init template code blocks, and little improvements #9696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3feecc2
Fix missing triple``` characters in markdown-features.mdx
heysokam Jan 3, 2024
c50ff89
add npx command to readme
slorber Jan 4, 2024
2633ae3
fix markdown features code blocks
slorber Jan 4, 2024
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
4 changes: 4 additions & 0 deletions packages/create-docusaurus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ npm init docusaurus
yarn create docusaurus
```

```bash
npx create-docusaurus@latest
```

## Usage

Please see the [installation documentation](https://docusaurus.io/docs/installation).
Expand Down
28 changes: 15 additions & 13 deletions ...s/create-docusaurus/templates/shared/docs/tutorial-basics/markdown-features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@ You can reference images relative to the current file as well. This is particula

Markdown code blocks are supported with Syntax highlighting.

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return (
<h1>Hello, Docusaurus!</h1>
)
}
```
````md
```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return <h1>Hello, Docusaurus!</h1>;
}
```
````

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
Expand All @@ -79,17 +79,19 @@ function HelloDocusaurus() {

Docusaurus has a special syntax to create admonitions and callouts:

:::tip My tip
```md
:::tip My tip

Use this awesome feature option
Use this awesome feature option

:::
:::

:::danger Take care
:::danger Take care

This action is dangerous
This action is dangerous

:::
:::
```

:::tip My tip

Expand Down
Loading