Skip to content

Commit 17aa5c1

Browse files
authored
Update README.md
1 parent c2fdf7f commit 17aa5c1

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,19 @@ Code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-p
1414

1515
"Photo formatting is made simple using [Bootstrap's grid system](https://getbootstrap.com/docs/4.4/layout/grid/). Easily create beautiful grids within your blog posts and project pages, also with support for [video](https://alshedivat.github.io/al-folio/blog/2023/videos/) and [audio](https://alshedivat.github.io/al-folio/blog/2023/audios/) embeds" [(See original README)](https://github.com/alshedivat/al-folio)
1616

17-
Note that each deployment runs [lychee](https://lychee.cli.rs/) to check for broken links.
18-
19-
We disabled the code formatting checker ([Prettier](https://prettier.io/)) since our goal is to make the markdown easy to edit. If it's desired to reanble it, errors from prettier are fixed by running 'npx prettier -w [file]' and pushing the new file (easiest to do on Analysis after installing the [Shopify Liquid Prettier Plugin](https://www.npmjs.com/package/@shopify/prettier-plugin-liquid)).
20-
2117
## Customizing
2218

2319
For customization details please refer to [CUSTOMIZE.md](CUSTOMIZE.md).
2420

21+
### Disabled Actions
22+
23+
`Check for broken links` disabled since it counts any internal link as an error.
24+
25+
`Check for broken links on site` disabled since, after clean-up, it doesn't find any serious errors but takes a long time to do so.
26+
27+
`Prettier code formatter` disabled since our goal is to make the markdown easy to edit. If it's desired to reanble it, errors from prettier are fixed by running 'npx prettier -w [file]' and pushing the new file (easiest to do on Analysis after installing the [Shopify Liquid Prettier Plugin](https://www.npmjs.com/package/@shopify/prettier-plugin-liquid)).
28+
29+
2530
## License
2631

2732
The theme is available as open source under the terms of the [MIT License](https://github.com/alshedivat/al-folio/blob/main/LICENSE).

0 commit comments

Comments
 (0)