From b8f2eecd1ffd6788251436142a30d28b37b24590 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji <sirbeejay1@gmail.com> Date: Thu, 11 Apr 2024 21:36:10 +0100 Subject: [PATCH 1/5] docs: update README --- README.md | 95 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 64 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 0aeb088..ffc85b9 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,61 @@ +<div align="center"> + # QuickStatic 🚀🦀🔥 -## The First static site generator build specifically for [Djot](https://djot.net) (A more powerful but strict Markdown dialect) +The first fast static site generator built in Rust specifically for [Djot](https://djot.net) (a more powerful but strict markdown dialect). -A fast static site generator written in Rust 🦀🚀. -A QuickStatic site should show the content first, and hide themes or configuration away. -We spend more time writing content than editing website templates and configs. +</div> -We should lean into features in markdown, such as directives and custom attributes, for adding features and components to markdow, instead of supporting MDX. +--- -## Installation +## Table of Contents -- Install using Rust cargo for now. Install cargo via: [Cargo installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html) -``` -cargo install quickstatic -``` +- [Priorities](#priorities) +- [Installation](#installation) +- [Basic Usage](#basic-usage) + - [Building Site](#building-site) + - [Watching Changes and Continous Rebuilding ](#watching-changes-and-continous-rebuilding) +- [Themes and Templates](#themes-and-templates) +- [Contributing and Help](#contributing-and-help) +- [License](#license) + +--- ## Priorities -- Simplicity -- Stability (Few features, and should not change very much) +A QuickStatic site should show the content first, and hide themes or configuration details. We spend more time writing content than editing website templates and configs. We should lean into features in markdown, such as directives and custom attributes, for adding features and components to markdown, instead of supporting MDX. QuickStatic generates static websites and focuses on doing that in a flexible and fast way. This project prioritizes: + +- Simplicity. +- Stability (few features—and should not change very much). - Content first. - Super flexible markdown, via extended markdown specifications. - Never support MDX (React in markdown). Instead, depend on markdown directives and the markdown attributes extended spec. - No asset management or SCSS or LESS or any other automated transpiler support. -- Build on top of shopify liquid templates. -- Prioritize productivity - -QuickStatic generates static websites, and focuses on doing that in a flexible and fast way. +- Build on top of Shopify liquid templates. +- Prioritize productivity. +## Installation -## Basic usage - -Quickstatic themes should be under `_quickstatic/themes/` directory. +QuickStatic can only be installed using the command below. If you don't have Rust Caro installed already, you can learn how to do so using the [Cargo Installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html). -Quickstatic public or build directory is `quickstatic/public` +``` +cargo install quickstatic +``` -Everything in the root directory gets copied into the output directory in that order, while markdown files are compiled to html files. -Anything with a .liquid extension is executed as a template and the .liquid extension striped. +## Basic Usage -Eg `sitemap.xml.liquid` would be evaluated and become `sitemap.xml` +- Quickstatic themes should be under `_quickstatic/themes/` directory. +- Quickstatic public or build directory is `quickstatic/public`. +- Everything in the root directory gets copied into the output directory in that order, while markdown files are compiled into HTML files. +- Anything with a `.liquid` extension is executed as a template and the `.liquid` extension is striped. E.g., `sitemap.xml.liquid` would be evaluated and become `sitemap.xml`. -### Build site +### Building Site ``` quickstatic build ``` -### Watch site for changes and continue rebuilding +### Watching Changes and Continous Rebuilding ``` quickstatic serve @@ -54,11 +63,11 @@ quickstatic serve ## Themes and Templates -QuickStatic themes can be written using the shopify liquid templating language. -You can learn more about it here  +QuickStatic themes can be written using the Shopify liquid templating language. You can learn more about it [here](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). To use any given template file for a particular page, simply reference the template file from the frontmatter. -Eg: + +For example: ```markdown --- @@ -70,10 +79,34 @@ Page Content. ``` -This is flexible, and allows you reference multiple themes from one QuickStatic site. +This is flexible and allows you to reference multiple themes from one QuickStatic site. + All themes exist in the `_quickstatic/themes/` folder. Your QuickStatic site comes with a default theme named `default`. +## Contributors Guide + +1. Fork the repository ([learn how to do this](https://help.github.com/articles/fork-a-repo)). + +2. Clone the forked repository like so: + +```bash +git clone https://github.com/<your username>/<repository name>.git && cd repository name +``` + +3. Install the required dependencies and configurations. + +4. Create a new branch like so: + +```bash +git checkout -b <new-branch-name> +``` + +5. Make your change(s), add tests, and ensure the tests still pass. + +6. Push your commit(s) to your fork and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)). + +7. Well done! Someone will attend to your pull request, provide some feedback, or merge it. +## License -## NOTE -- Licenced under the MIT License. +This repository is published under the [MIT](LICENSE) license. From ae8d57919530444cb669fd803ba5dbf1be709d6a Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji <sirbeejay1@gmail.com> Date: Thu, 11 Apr 2024 21:38:51 +0100 Subject: [PATCH 2/5] docs: update toc --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ffc85b9..58d14f2 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,8 @@ The first fast static site generator built in Rust specifically for [Djot](https - [Priorities](#priorities) - [Installation](#installation) - [Basic Usage](#basic-usage) - - [Building Site](#building-site) - - [Watching Changes and Continous Rebuilding ](#watching-changes-and-continous-rebuilding) - [Themes and Templates](#themes-and-templates) -- [Contributing and Help](#contributing-and-help) +- [Contributors Guide](#contributors-guide) - [License](#license) --- @@ -49,13 +47,13 @@ cargo install quickstatic - Everything in the root directory gets copied into the output directory in that order, while markdown files are compiled into HTML files. - Anything with a `.liquid` extension is executed as a template and the `.liquid` extension is striped. E.g., `sitemap.xml.liquid` would be evaluated and become `sitemap.xml`. -### Building Site +To build the site, kindly run the command below: ``` quickstatic build ``` -### Watching Changes and Continous Rebuilding +To watch for changes and continuously rebuild the site, kindly run the command below: ``` quickstatic serve From b19e55d4be3a5c98856812f4ab46f89550ffe0f5 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji <sirbeejay1@gmail.com> Date: Thu, 11 Apr 2024 21:39:49 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 58d14f2..9bd861c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # QuickStatic 🚀🦀🔥 -The first fast static site generator built in Rust specifically for [Djot](https://djot.net) (a more powerful but strict markdown dialect). +The first and fast static site generator built in Rust specifically for [Djot](https://djot.net) (a more powerful but strict markdown dialect). </div> From 3bb9475f8da4cef7f444d9ae26cef4bb87ba1ef4 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji <sirbeejay1@gmail.com> Date: Thu, 11 Apr 2024 21:41:45 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9bd861c..7dbdd95 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ A QuickStatic site should show the content first, and hide themes or configurati ## Installation -QuickStatic can only be installed using the command below. If you don't have Rust Caro installed already, you can learn how to do so using the [Cargo Installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html). +QuickStatic can only be installed using the command below (If you don't have Rust Caro installed already, you should read the [Cargo Installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html)). ``` cargo install quickstatic From 7226179feb886500da8f4cee7447584b8ee40158 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji <sirbeejay1@gmail.com> Date: Thu, 11 Apr 2024 21:57:20 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7dbdd95..0774e8a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # QuickStatic 🚀🦀🔥 -The first and fast static site generator built in Rust specifically for [Djot](https://djot.net) (a more powerful but strict markdown dialect). +The first and fast static site generator built in Rust specifically for [Djot](https://djot.net?utm_source=https://github.com/tonyalaribe/quickstatic) (a more powerful but strict markdown dialect). </div> @@ -14,6 +14,7 @@ The first and fast static site generator built in Rust specifically for [Djot](h - [Installation](#installation) - [Basic Usage](#basic-usage) - [Themes and Templates](#themes-and-templates) +- [Repo Activity](#repo-activity) - [Contributors Guide](#contributors-guide) - [License](#license) @@ -21,7 +22,7 @@ The first and fast static site generator built in Rust specifically for [Djot](h ## Priorities -A QuickStatic site should show the content first, and hide themes or configuration details. We spend more time writing content than editing website templates and configs. We should lean into features in markdown, such as directives and custom attributes, for adding features and components to markdown, instead of supporting MDX. QuickStatic generates static websites and focuses on doing that in a flexible and fast way. This project prioritizes: +A QuickStatic site should show the content first, and hide themes or configuration details. We spend more time writing content than editing website templates and configs. We should lean into features in markdown, such as directives and custom attributes, for adding features and components to markdown, instead of supporting MDX. QuickStatic generates static websites and focuses on doing that in a flexible and fast way. This project prioritizes the following tenets: - Simplicity. - Stability (few features—and should not change very much). @@ -34,7 +35,7 @@ A QuickStatic site should show the content first, and hide themes or configurati ## Installation -QuickStatic can only be installed using the command below (If you don't have Rust Caro installed already, you should read the [Cargo Installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html)). +QuickStatic can be installed using the `cargo` command below (if you don't have Rust Cargo installed already, you should read the [Cargo Installation Guide](https://doc.rust-lang.org/cargo/getting-started/installation.html)). ``` cargo install quickstatic @@ -45,7 +46,7 @@ cargo install quickstatic - Quickstatic themes should be under `_quickstatic/themes/` directory. - Quickstatic public or build directory is `quickstatic/public`. - Everything in the root directory gets copied into the output directory in that order, while markdown files are compiled into HTML files. -- Anything with a `.liquid` extension is executed as a template and the `.liquid` extension is striped. E.g., `sitemap.xml.liquid` would be evaluated and become `sitemap.xml`. +- Anything with a `.liquid` extension is executed as a template and the `.liquid` extension is striped. For example, `sitemap.xml.liquid` would be evaluated and become `sitemap.xml`. To build the site, kindly run the command below: @@ -61,11 +62,7 @@ quickstatic serve ## Themes and Templates -QuickStatic themes can be written using the Shopify liquid templating language. You can learn more about it [here](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). - -To use any given template file for a particular page, simply reference the template file from the frontmatter. - -For example: +QuickStatic themes can be written using the [Shopify liquid templating language](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers). To use any given template file for a particular page, simply reference the template file from the frontmatter. For example: ```markdown --- @@ -74,12 +71,17 @@ layout: themeName/blog/index.liquid --- Page Content. - ``` This is flexible and allows you to reference multiple themes from one QuickStatic site. -All themes exist in the `_quickstatic/themes/` folder. Your QuickStatic site comes with a default theme named `default`. +> [!TIP] +> +> All themes exist in the `_quickstatic/themes/` folder and your QuickStatic site comes with a default theme named `default`. + +## Repo Activity + + ## Contributors Guide @@ -88,7 +90,7 @@ All themes exist in the `_quickstatic/themes/` folder. Your QuickStatic site com 2. Clone the forked repository like so: ```bash -git clone https://github.com/<your username>/<repository name>.git && cd repository name +git clone https://github.com/<your username>/quickstatic.git && cd quickstatic ``` 3. Install the required dependencies and configurations.