Skip to content

Commit

Permalink
Revised casing of Component names
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffreymcgill committed Aug 3, 2023
1 parent 2a2fa80 commit 6697ee1
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions about.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Retype is only made possible because of the hard work of other amazing open-sour
| [Vue.js](https://vuejs.org/) | [MIT](https://github.com/vuejs/vue/blob/dev/LICENSE) | Client UI framework |
| [Turbo](https://turbo.hotwired.dev/) | [MIT](https://github.com/hotwired/turbo/blob/main/MIT-LICENSE) | HTML over the wire |
| [Lunr](https://lunrjs.com/) | [MIT](https://github.com/olivernn/lunr.js/blob/master/LICENSE) | Search index |
| [Prism](https://prismjs.com/) | [MIT](https://github.com/PrismJS/prism/blob/master/LICENSE) | [Code block](/components/code-block.md#syntax-highlighting) formatting |
| [Prism](https://prismjs.com/) | [MIT](https://github.com/PrismJS/prism/blob/master/LICENSE) | [Code Block](/components/code-block.md#syntax-highlighting) formatting |
| [Mermaid](https://mermaid-js.github.io/mermaid/) | [MIT](https://github.com/mermaid-js/mermaid/blob/develop/LICENSE) | [Mermaid](/components/mermaid.md) diagrams |
| [KaTeX](https://github.com/KaTeX/KaTeX) | [MIT](https://github.com/KaTeX/KaTeX/blob/master/LICENSE) | [Math formula](/components/math-formulas.md) rendering |
| [Clipboard.js](https://clipboardjs.com) | [MIT](https://clipboardjs.com/) | Code block copy to clipboard |
| [Clipboard.js](https://clipboardjs.com) | [MIT](https://clipboardjs.com/) | Code Block copy to clipboard |
| [YamlDotNet](https://github.com/aaubry/YamlDotNet) | [MIT](https://github.com/aaubry/YamlDotNet/blob/master/LICENSE.txt) | YAML parsing |

## License
Expand Down
14 changes: 7 additions & 7 deletions components/code-block.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
icon: code-square
tags: [component]
---
# Code block
# Code Block

Blocks of code or any preformatted text can be displayed by wrapping with triple backticks characters before and after.

Expand Down Expand Up @@ -48,12 +48,12 @@ Retype includes the functionality to set a title on your markdown code blocks.

+++ :icon-code: Source
~~~
``` Code block title
``` Code Block title
const msg = "Set a code block title";
```
~~~
+++ :icon-play: Demo
``` Code block title
``` Code Block title
const msg = "Set a code block title";
```
+++
Expand All @@ -62,19 +62,19 @@ The title can be used in conjunction with the code reference type.

+++ :icon-code: Source
~~~
```js Code block title
```js Code Block title
const msg = "Set a code block title";
```
~~~
+++ :icon-play: Demo
```js Code block title
```js Code Block title
const msg = "Set a code block title";
```
+++

The `title` should be separated from the opening fence by one space, for example the pattern `` ``` Code block title`` is recommended.
The `title` should be separated from the opening fence by one space, for example the pattern `` ``` Code Block title`` is recommended.

If a code language is used, separate the `title` from the `lang` by one space. The pattern `` ```js Code block title`` will work as expected.
If a code language is used, separate the `title` from the `lang` by one space. The pattern `` ```js Code Block title`` will work as expected.

---

Expand Down
2 changes: 1 addition & 1 deletion components/code-snippet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
icon: file-code
tags: [component]
---
# Code snippet
# Code Snippet

A code snippet allow you to include the content of another text file or a portion of that file into a code block on another page.

Expand Down
2 changes: 1 addition & 1 deletion components/file-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
icon: download
tags: [component]
---
# File download
# File Download

A static file download component can be configured by using the `!file` specifier in a link.

Expand Down
2 changes: 1 addition & 1 deletion components/math-formulas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
icon: beaker
tags: [component]
---
# Math formulas
# Math Formulas

Retype supports rendering math formulas written according to the [LaTeX](https://en.wikipedia.org/wiki/LaTeX) grammar. Internally, Retype is powered by [$\KaTeX$](https://katex.org/) and supports all syntax of the library.

Expand Down
10 changes: 5 additions & 5 deletions components/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ Retype flavored Markdown supports custom components, including:
- [Alert](alert.md)
- [Badge](badge.md)
- [Button](button.md)
- [Code block](code-block.md)
- [Code snippet](code-snippet.md)
- [Code Block](code-block.md)
- [Code Snippet](code-snippet.md)
- [Column](column.md)
- [Container](container.md)
- [Embed](embed.md)
- [Emoji](emoji.md)
- [File download](file-download.md)
- [File Download](file-download.md)
- [Icon](icon.md)
- [Image](image.md)
- [List](list.md)
- [Math formulas](math-formulas.md)
- [Math Formulas](math-formulas.md)
- [Mermaid](mermaid.md)
- [Panel](panel.md)
- [Reference link](reference-link.md)
- [Reference Link](reference-link.md)
- [Tab](tab.md)
- [Table](table.md)
4 changes: 2 additions & 2 deletions components/reference-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
icon: link
tags: [component]
---
# Reference link
# Reference Link

A special type of reference link can be configured by using the `!ref` specifier in a link.

Expand All @@ -28,7 +28,7 @@ The text of the link can be explicitly set by passing as the first part of the c

Clicking anywhere within the reference link component will navigate to that new page.

From a functionality perspective, there is no difference betwen a `!ref` component and a regular hyperlink. The difference between the two is just how they are presented, with a Reference link component being more prominent than a regular hyperlink.
From a functionality perspective, there is no difference betwen a `!ref` component and a regular hyperlink. The difference between the two is just how they are presented, with a Reference Link component being more prominent than a regular hyperlink.

---

Expand Down
2 changes: 1 addition & 1 deletion roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ Released: 2021-03-12
- [x] [`retype start`](/guides/cli.md#retype-start) command.
- [x] Live Reload when using [`retype start`](/guides/cli.md#retype-start).
- [x] [**.yml**](/configuration/page.md#separate-yml-file) option for Page or Folder configs.
- [x] Code block [title](/components/code-block.md#title).
- [x] Code Block [title](/components/code-block.md#title).
- [x] [line numbering](/components/code-block.md#line-numbers) in code blocks.
+++

Expand Down

0 comments on commit 6697ee1

Please sign in to comment.