From 41fee77db876a1abdcda4ecfe049346a87ee2260 Mon Sep 17 00:00:00 2001 From: Yann Bertrand <5855339+yannbertrand@users.noreply.github.com> Date: Wed, 17 Aug 2022 11:07:32 +0200 Subject: [PATCH] :memo: Add deprecation notices for Docsify, Docusaurus & VuePress builds --- build/docsify/readme.md | 2 +- build/docusaurus/readme.md | 2 +- build/github/readme.md | 2 +- build/readme.md | 57 ++++++++++++++++++++++++++++++++++++++ build/vuepress/readme.md | 2 +- readme.md | 54 ------------------------------------ 6 files changed, 61 insertions(+), 58 deletions(-) create mode 100644 build/readme.md diff --git a/build/docsify/readme.md b/build/docsify/readme.md index 4391c94..567c588 100644 --- a/build/docsify/readme.md +++ b/build/docsify/readme.md @@ -1,6 +1,6 @@ # docsify Build -![Docsify build status](https://api.netlify.com/api/v1/badges/8af81039-12cc-4080-a434-d8f162d5c416/deploy-status) +:warning: Docsify build is not maintained anymore. Please note we were using Docsify@4.12.2 at the time. ## My opinion diff --git a/build/docusaurus/readme.md b/build/docusaurus/readme.md index 4224621..983ebc7 100644 --- a/build/docusaurus/readme.md +++ b/build/docusaurus/readme.md @@ -1,6 +1,6 @@ # Docusaurus Build -![Docusaurus build status](https://api.netlify.com/api/v1/badges/92522518-2bcc-4086-8926-6c3534666011/deploy-status) +:warning: Docusaurus build is not maintained anymore. Please note we were using Docusaurus@1.14.7 at the time. ## My opinion diff --git a/build/github/readme.md b/build/github/readme.md index cb42bb3..e3e1d31 100644 --- a/build/github/readme.md +++ b/build/github/readme.md @@ -1,6 +1,6 @@ # GitHub Build -![GitHub build status](https://github.com/yannbertrand/macos-defaults/workflows/Build%20GitHub/badge.svg) +:warning: GitHub build is not maintained anymore. Instead of building a website, I wanted to try constructing GitHub readmes linked from one to the other. As the project is simple, I thought it could be a decent choice. diff --git a/build/readme.md b/build/readme.md new file mode 100644 index 0000000..6b0821d --- /dev/null +++ b/build/readme.md @@ -0,0 +1,57 @@ +# macOS-defaults builder 🤖 +:warning: This is not maintained anymore. We now only build the production website. The sources may stay in the repo as old examples. + +Compare Static Site Generators by automatically building websites from [this yaml file](../defaults.yml) content 🏗. + +It used to build to: + + + + + + + + + + + + + + + + + + + + +
GitHub Flavored MarkdownVuePressDocusaurusdocsify
+ + + + + + + +
latest1.9.11.14.7latest
+ +## Features +:warning: This section is not up to date. Please note the version used for comparison above. + +/ | [GitHub](https://github.github.com/gfm/) | [VuePress](https://vuepress.vuejs.org/) | [Docusaurus](https://docusaurus.io/) | [docsify](https://docsify.js.org/#/) +--: | :-: | :-: | :-: | :-: +**Stars ⭐️** | N/A | [![](https://img.shields.io/github/stars/vuejs/vuepress?label=&color=yellow)](https://github.com/vuejs/vuepress) | [![](https://img.shields.io/github/stars/facebook/docusaurus?label=&color=yellow)](https://github.com/facebook/Docusaurus) | [![](https://img.shields.io/github/stars/docsifyjs/docsify?label=&color=yellow)](https://github.com/docsifyjs/docsify) +**No JS needed** | ✅ | ✅ | ✅ | ❌ +**Code highlight** | ✅
[docs](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) | ✅
[docs](https://vuepress.vuejs.org/guide/markdown.html#syntax-highlighting-in-code-blocks)
([Prism.js](https://prismjs.com/)) | ✅
[docs](https://docusaurus.io/docs/en/doc-markdown#syntax-highlighting)
([Highlight.js](https://highlightjs.org/)) | ✅
[docs](https://docsify.js.org/#/language-highlight?id=language-highlight)
(plugin [Prism.js](https://prismjs.com/)) +**Search** | ✅ | ✅ | ❌ | ✅
([plugin](https://docsify.js.org/#/plugins?id=full-text-search)) +**Video support** | ❌ | ✅ | ✅ | ✅ +**Official themes** | 1 | 1 | 1 | 4 +**Netlify build time** | N/A | 57s | 1m 1s | 38s +**Click to copy code** | ❌ | ❌ | ❌ | ✅
([plugin](https://docsify.js.org/#/plugins?id=copy-to-clipboard)) +**Category page** | ✅ | ✅ | ❌ | ✅ +**Default port** | N/A | 8080 | 3000 | 3000 + +## How does it work? +- See [GitHub's build detail](./github/#readme) +- See [VuePress' build detail](./vuepress/#readme) +- See [Docusaurus' build detail](./docusaurus/#readme) +- See [Docsify's build detail](./docsify/#readme) diff --git a/build/vuepress/readme.md b/build/vuepress/readme.md index 9a39ce1..8cf73bf 100644 --- a/build/vuepress/readme.md +++ b/build/vuepress/readme.md @@ -1,6 +1,6 @@ # VuePress Build -![VuePress build status](https://api.netlify.com/api/v1/badges/e73b1f35-9442-45e1-b7b4-6eed2b102a9c/deploy-status) +:warning: VuePress build is not maintained anymore. Please note we were using VuePress@1.9.1 at the time. ## My opinion diff --git a/readme.md b/readme.md index 261d455..a853485 100644 --- a/readme.md +++ b/readme.md @@ -52,60 +52,6 @@ Using this [bash script](diff.sh) (`bash ./diff.sh`), you'll be able to find out After you find the key with your options, simply run `defaults find ${keyname}` to find the domain it is saved in. -# macOS-defaults builder 🤖 -> Compare Static Site Generators by automatically building websites from [this yaml file](./defaults.yml) content 🏗. - -It currently builds to: - - - - - - - - - - - - - - - - - - - - -
GitHub Flavored MarkdownVuePressDocusaurusdocsify
- - - - - - - -
latest1.6.01.14.6latest
- -## Features -/ | [GitHub](https://github.github.com/gfm/) | [VuePress](https://vuepress.vuejs.org/) | [Docusaurus](https://docusaurus.io/) | [docsify](https://docsify.js.org/#/) ---: | :-: | :-: | :-: | :-: -**Stars ⭐️** | N/A | [![](https://img.shields.io/github/stars/vuejs/vuepress?label=&color=yellow)](https://github.com/vuejs/vuepress) | [![](https://img.shields.io/github/stars/facebook/docusaurus?label=&color=yellow)](https://github.com/facebook/Docusaurus) | [![](https://img.shields.io/github/stars/docsifyjs/docsify?label=&color=yellow)](https://github.com/docsifyjs/docsify) -**No JS needed** | ✅ | ✅ | ✅ | ❌ -**Code highlight** | ✅
[docs](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) | ✅
[docs](https://vuepress.vuejs.org/guide/markdown.html#syntax-highlighting-in-code-blocks)
([Prism.js](https://prismjs.com/)) | ✅
[docs](https://docusaurus.io/docs/en/doc-markdown#syntax-highlighting)
([Highlight.js](https://highlightjs.org/)) | ✅
[docs](https://docsify.js.org/#/language-highlight?id=language-highlight)
(plugin [Prism.js](https://prismjs.com/)) -**Search** | ✅ | ✅ | ❌ | ✅
([plugin](https://docsify.js.org/#/plugins?id=full-text-search)) -**Video support** | ❌ | ✅ | ✅ | ✅ -**Official themes** | 1 | 1 | 1 | 4 -**Netlify build time** | N/A | 57s | 1m 1s | 38s -**Click to copy code** | ❌ | ❌ | ❌ | ✅
([plugin](https://docsify.js.org/#/plugins?id=copy-to-clipboard)) -**Category page** | ✅ | ✅ | ❌ | ✅ -**Default port** | N/A | 8080 | 3000 | 3000 - -## How does it work? -- See [GitHub's build detail](./build/github/#readme) [![GitHub build status](https://github.com/yannbertrand/macos-defaults/workflows/Build%20GitHub/badge.svg)](https://github.com/yannbertrand/macos-defaults/tree/current) -- See [VuePress' build detail](./build/vuepress/#readme) [![VuePress build status](https://img.shields.io/netlify/e73b1f35-9442-45e1-b7b4-6eed2b102a9c)](https://macos-defaults-vuepress.netlify.app/) -- See [Docusaurus' build detail](./build/docusaurus/#readme) [![Docusaurus build status](https://img.shields.io/netlify/92522518-2bcc-4086-8926-6c3534666011)](https://macos-defaults-docusaurus.netlify.app/) -- See [Docsify's build detail](./build/docsify/#readme) [![Docsify build status](https://img.shields.io/netlify/8af81039-12cc-4080-a434-d8f162d5c416)](https://macos-defaults-docsify.netlify.app/) - # macOS-defaults recorder 📷 > Programmatically record a Mac screen with a predefined list of actions 📹.