Skip to content

Commit

Permalink
docs: project list and human titles
Browse files Browse the repository at this point in the history
  • Loading branch information
wdavidw committed Jan 24, 2025
1 parent 02cb4ae commit e3145d9
Show file tree
Hide file tree
Showing 9 changed files with 64 additions and 34 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,34 @@ The following command bumps the package versions, creates the tags, synchronizes
```bash
yarn run version
```

Projects:

- [Remark links absolute](./remark/links-absolute)
Convert relative links to absolute link.
- [Remark Public images](./remark/public-images)
Upload every image present on the markdown article into a public GIT repository and update the `src` image attribute to reflect the new public URL.
- [Remark Read Frontmatter](./remark/read-frontmatter)
Parse frontmatter and insert the "data" field in the vfile object.
- [Remark table of content](./remark/table-of-content)
This is a Remark plugin to extract a table of content from your Markdown file.
- [Remark Table to Code](./remark/table-to-code)
Convert markdown tables to HTML code instead of HTML tables.
- [Remark Title to Frontmatter](./remark/title-to-frontmatter)
Export the title present in the Markdown to the frontmatter.

Gatsby legacy projects:

- [Gatsby Remark enforce empty lines](./legacy/gatsby-remark/enforce-empty-lines)
Ensure there is an empty line between each blocks. It print a warning with the file name and the line number. A block is one of "blockquote", "code", "heading", "html", "list", "paragraph" and "thematicBreak".

- [Gatsby Remark enforce empty lines](./legacy/gatsby-remark/lang-in-code-block)
Ensure that every code block define a lang. It print a warning with the file name and the line number.
- [Gatsby Remark snippet URL](./legacy/gatsby-remark/snippet-url)
Display a link next to the source code when it is embeded from a source file.
- [Gatsby Remark snippet URL prepare](./legacy/gatsby-remark/snippet-url-prepare)
The plugin work conjointly with the `gatsby-remark-embed-snippet` plugin by updating the Markdown AST node with the `data.embed.file` property. Its value is the embeded source file.
- [Gatsby Remark title to frontmatter](./legacy/gatsby-remark/title-to-frontmatter)
This package is a Gatsby module to move the title from the Markdown content to the frontmatter object.
- [Gatsby Caddy redirect configuration generation](./legacy/gatsvy-caddy-redirects-conf)
Generate a Caddy compatible config file.
5 changes: 2 additions & 3 deletions legacy/gatsby-remark/enforce-empty-lines/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@

# Package `gatsby-remark-enforce-empty-lines`
# Gatsby Remark enforce empty lines

Ensure there is an empty line between each blocks. It print a warning with the file name and the line number. A block is one of "blockquote", "code", "heading", "html", "list", "paragraph" and "thematicBreak".

Options are:

* `include` (array)
- `include` (array)
Globing expression of paths matching the file path, default to all files, for example `**/*.md`.

The plugin can be disabled on a document basis by setting the `noEnforceEmptyLines` frontmatter property to `true`.
5 changes: 2 additions & 3 deletions legacy/gatsby-remark/lang-in-code-block/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@

# Package `gatsby-remark-enforce-empty-lines`
# Gatsby Remark enforce empty lines

Ensure that every code block define a lang. It print a warning with the file name and the line number.

Options are:

* `include` (array)
- `include` (array)
Globing expression of paths matching the file path, default to all files, for example `**/*.md`.

The plugin can be disabled on a document basis by setting the `noLangInCodeBlock` frontmatter property to `true`.
5 changes: 2 additions & 3 deletions legacy/gatsby-remark/snippet-url-prepare/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@

# Package `gatsby-remark-snippet-url-prepare`
# Gatsby Remark snippet URL prepare

The plugin work conjointly with the `gatsby-remark-embed-snippet` plugin by updating the Markdown AST node with the `data.embed.file` property. Its value is the embeded source file.

Options are:

* `include` (array)
- `include` (array)
Globing expression of paths matching the file path, default to all files, for example `**/*.md`.

The plugin can be disabled on a document basis by setting the `noSnippedUrl` frontmatter property to `true`.
9 changes: 4 additions & 5 deletions legacy/gatsby-remark/snippet-url/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

# Package `gatsby-remark-snippet-url`
# Gatsby Remark snippet URL

Display a link next to the source code when it is embeded from a source file.

The plugin works conjointly with the `gatsby-remark-embed-snippet` and `gatsby-remark-prismjs` plugins and must be declare after. Also, it requires the declaration of `gatsby-remark-enforce-empty-lines-prepare` before `gatsby-remark-embed-snippet`.

Options are:

* `include` (array)
- `include` (array)
Globing expression of paths matching the file path, default to all files, for example `**/*.md`.
* `message` (string|function)
- `message` (string|function)
The message inside a link. If defined as a string, `{{FILE}}` is replaced with
the embed file name.
* `url` (string|function)
- `url` (string|function)
The URL of the link. If defined as a string, `{{FILE}}` is replaced with
the embed file name.

Expand Down
31 changes: 17 additions & 14 deletions legacy/gatsby-remark/title-to-frontmatter/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

# Package `gatsby-remark-title-to-frontmatter`
# Gatsby Remark title to frontmatter

This package is a Gatsby module to move the title from the Markdown content to the frontmatter object.

Expand All @@ -24,24 +23,28 @@ Open your `gatsby-config.js` file and register the plugin:
```js
export default {
siteMetadata: {
title: 'Gatsby website',
title: "Gatsby website",
},
plugins: [{
plugins: [
{
// Gatsby plugins registration goes here
}, {
},
{
resolve: `gatsby-transformer-remark`,
options: {
// Remark configuration goes here
plugins: [{
resolve: 'gatsby-remark-title-to-frontmatter',
options: {
include: [
'**/*.md', // an include glob to match against
],
plugins: [
{
resolve: "gatsby-remark-title-to-frontmatter",
options: {
include: [
"**/*.md", // an include glob to match against
],
},
},
}],
],
},
}
},
],
}
};
```
2 changes: 1 addition & 1 deletion legacy/gatsvy-caddy-redirects-conf/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Package `gatsby-caddy-redirects-conf`
# Gatsby Caddy redirect configuration generation

Generate a Caddy compatible config file.
4 changes: 2 additions & 2 deletions remark/public-images/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Public images
# Remark Public images

Upload every image present on the markdown article into a public GIT repository and update the `src` image attribute to reflect the new public URL.

Expand All @@ -22,7 +22,7 @@ Upload every image present on the markdown article into a public GIT repository

```js
{

"plugin": require('remark-public_images'),
"settings": {
"target": `${require('os').homedir()}/.medium_git`,
Expand Down
6 changes: 3 additions & 3 deletions remark/table-of-content/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Plugin `remark-table-of-content`
# Remark table of content

This is a Remark plugin to extract a table of content from your Markdown file.

Expand All @@ -11,7 +11,7 @@ It supports CommonJS and ES modules.
The minimum heading level to include, default with heading 1 (`# Heading 1`).
* `depth_max`, integer, default `3`
The maximum heading level to include, default with heading 1 (`### Heading 3`).
* `property`, string|array(string), default `toc`
* `property`, string|array(string), default `toc`
The [vfile](https://github.com/vfile/vfile) property name where to find the table of content array. The value may be an array if the property is made of multiple levels.

## Simple usage
Expand Down Expand Up @@ -83,4 +83,4 @@ assert.deepEqual(data, {
})
```

A value is preserved if the property is already exists in the vfile, for example in the frontmatter,
A value is preserved if the property is already exists in the vfile, for example in the frontmatter,

0 comments on commit e3145d9

Please sign in to comment.