From 8535f648fabb5138a7424069c3fdba8ac1eb3b9e Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Mon, 7 Oct 2024 23:36:56 +0200 Subject: [PATCH 1/9] Update README.md Placeholder, trying to make the readme actually useful for people who can't program. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96ecaed..593b343 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,28 @@ Monospace fonts are dear to many of us. Some find them more readable, consistent, and beautiful, than their proportional alternatives. Maybe we’re just brainwashed from spending years in terminals? Or are we hopelessly nostalgic? I’m not sure. But I like them, and that’s why I started experimenting with all-monospace Web. -https://owickstrom.github.io/the-monospace-web/ +Here are a few websites built using the Monospace Web: +* Official Website: https://owickstrom.github.io/the-monospace-web/ +* Lucien Hinderling's Website : https://hinderling.github.io/ +* AZETTL Websolutions: https://azettl.net/ -## Build +## Installation & Usage +### Advanced Users +1. Clone the repo +2. Run nix or whatever ``` nix develop # or `direnv allow .` make ``` +3. ??? +4. Huh +5. Okay but how do I convert the md + +### Regular Users +https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small + ## License [MIT](LICENSE.md) From 3fe38ae6594c429eccc42e08dfe276e4006a6cb0 Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Mon, 7 Oct 2024 23:44:44 +0200 Subject: [PATCH 2/9] Update README.md improved linking --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 593b343..05e98c8 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ make 5. Okay but how do I convert the md ### Regular Users -https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small +[There is currently no plug & play method to build websites using the Monospace Web.](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) ## License From 9a7b99a312052572b014978578dbe536144377dc Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Mon, 7 Oct 2024 23:47:41 +0200 Subject: [PATCH 3/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 05e98c8..7b5586f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Monospace fonts are dear to many of us. Some find them more readable, consistent, and beautiful, than their proportional alternatives. Maybe we’re just brainwashed from spending years in terminals? Or are we hopelessly nostalgic? I’m not sure. But I like them, and that’s why I started experimenting with all-monospace Web. -Here are a few websites built using the Monospace Web: +Here are a few example websites built using the Monospace Web: * Official Website: https://owickstrom.github.io/the-monospace-web/ * Lucien Hinderling's Website : https://hinderling.github.io/ * AZETTL Websolutions: https://azettl.net/ From 8798c6a81ce72d3dadc01046752893f2d7cd5bb3 Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Tue, 8 Oct 2024 00:05:58 +0200 Subject: [PATCH 4/9] Update README.md saving process --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7b5586f..9718446 100644 --- a/README.md +++ b/README.md @@ -11,19 +11,20 @@ Here are a few example websites built using the Monospace Web: ### Advanced Users 1. Clone the repo -2. Run nix or whatever +2. Build using nix ``` nix develop # or `direnv allow .` make ``` - -3. ??? -4. Huh -5. Okay but how do I convert the md +3. You can figure out the rest from there idk I'm not doing this ### Regular Users [There is currently no plug & play method to build websites using the Monospace Web.](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) +1. Install [Pandoc](https://pandoc.org/), if you are running Windows, the version of the installer that you want is "windows-x86_64". +2. Ignore the other dependency. It has no easy install method and all it does is automatically refresh your website when you make edits. You can just close the tab and open the html file when you make an edit. +3. Create your website as a markdown file, using Pandoc's markdown formattng. [(Here is an example file)](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. + ## License [MIT](LICENSE.md) From 8a21b103cc15671bb2309a25b46c8eea704a112f Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Tue, 8 Oct 2024 00:06:48 +0200 Subject: [PATCH 5/9] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 9718446..18001da 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,8 @@ make ``` 3. You can figure out the rest from there idk I'm not doing this -### Regular Users -[There is currently no plug & play method to build websites using the Monospace Web.](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) +### [Regular Users](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) 1. Install [Pandoc](https://pandoc.org/), if you are running Windows, the version of the installer that you want is "windows-x86_64". 2. Ignore the other dependency. It has no easy install method and all it does is automatically refresh your website when you make edits. You can just close the tab and open the html file when you make an edit. 3. Create your website as a markdown file, using Pandoc's markdown formattng. [(Here is an example file)](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. From ac9443748347b4dba7575f9e2788d1f7c189863f Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Tue, 8 Oct 2024 00:26:44 +0200 Subject: [PATCH 6/9] Update README.md --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 18001da..7d08f33 100644 --- a/README.md +++ b/README.md @@ -9,20 +9,24 @@ Here are a few example websites built using the Monospace Web: ## Installation & Usage -### Advanced Users -1. Clone the repo -2. Build using nix +### 👩‍💻 Advanced Users +1. Clone the repo. +2. Build using Nix: ``` nix develop # or `direnv allow .` make ``` -3. You can figure out the rest from there idk I'm not doing this +3. Enjoy making an awesome website. +

- -### [Regular Users](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) -1. Install [Pandoc](https://pandoc.org/), if you are running Windows, the version of the installer that you want is "windows-x86_64". +### [🙍‍♂️](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) Regular Users +1. Install [Pandoc](https://pandoc.org/), if you are running Windows, the version of the installer that you want is `windows-x86_64`. 2. Ignore the other dependency. It has no easy install method and all it does is automatically refresh your website when you make edits. You can just close the tab and open the html file when you make an edit. -3. Create your website as a markdown file, using Pandoc's markdown formattng. [(Here is an example file)](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. +3. Create your website as a markdown file, using Pandoc's markdown formattng. [Here is an example file](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. +4. Open your command line, navigate to your project's folder, and write the following command `pandoc --toc -s --css reset.css --css index.css -i yoursourcefile.md -o output.html --template=template.html` + * You'll need to replace the file names with your own. + * You can and should automate this process with a batch script. +6. test ## License From 06e177d527c19ec362167ecb5d651e7fd855c309 Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Tue, 8 Oct 2024 00:42:42 +0200 Subject: [PATCH 7/9] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7d08f33..4da32a4 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,29 @@ Here are a few example websites built using the Monospace Web: ## Installation & Usage ### 👩‍💻 Advanced Users -1. Clone the repo. +1. Clone the repository. 2. Build using Nix: ``` nix develop # or `direnv allow .` make ``` -3. Enjoy making an awesome website. +3. Make the thing.

### [🙍‍♂️](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) Regular Users -1. Install [Pandoc](https://pandoc.org/), if you are running Windows, the version of the installer that you want is `windows-x86_64`. -2. Ignore the other dependency. It has no easy install method and all it does is automatically refresh your website when you make edits. You can just close the tab and open the html file when you make an edit. -3. Create your website as a markdown file, using Pandoc's markdown formattng. [Here is an example file](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. -4. Open your command line, navigate to your project's folder, and write the following command `pandoc --toc -s --css reset.css --css index.css -i yoursourcefile.md -o output.html --template=template.html` +1. Install [Pandoc](https://pandoc.org/). If you are running Windows, the version of the installer that you want is `windows-x86_64`. +2. Ignore the other dependency. It has no easy install method and all it does is automatically refresh your website when you make edits. +3. From this repository, download the following files: + * reset.css (This file ensures everything works, don't touch it) + * index.css (This file controls the visual style for the website, modify only if you understand [CSS](https://www.youtube.com/watch?v=OEV8gMkCHXQ)) + * template.html (This defines the structural layout for Monospace Web, don't touch it unless you understand [HTML](https://www.youtube.com/watch?v=ok-plXXHlWw)) + * To download files from a repository, click on its name and it will allow you to inspect the individual file, then, on the right side of the page there should be a tiny button (next to a button that says "RAW") to download it. +4 Create a folder anywhere in your computer and place the downloaded files inside. Your website will live here. +5. Create your website as a markdown file, using Pandoc's markdown formattng. [Here is an example file](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. +6. Open your command line, navigate to your project's folder, and write the following command `pandoc --toc -s --css reset.css --css index.css -i yoursourcefile.md -o output.html --template=template.html` * You'll need to replace the file names with your own. * You can and should automate this process with a batch script. -6. test +7. test ## License From e6cc2cc952a7810982505e1931d32eca4fb683a5 Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Tue, 8 Oct 2024 00:48:13 +0200 Subject: [PATCH 8/9] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4da32a4..dc01171 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,6 @@ Here are a few example websites built using the Monospace Web: nix develop # or `direnv allow .` make ``` -3. Make the thing. -

### [🙍‍♂️](https://pbs.twimg.com/media/GYWlOmEXQAA9nWF?format=png&name=small) Regular Users 1. Install [Pandoc](https://pandoc.org/). If you are running Windows, the version of the installer that you want is `windows-x86_64`. @@ -27,12 +25,13 @@ make * index.css (This file controls the visual style for the website, modify only if you understand [CSS](https://www.youtube.com/watch?v=OEV8gMkCHXQ)) * template.html (This defines the structural layout for Monospace Web, don't touch it unless you understand [HTML](https://www.youtube.com/watch?v=ok-plXXHlWw)) * To download files from a repository, click on its name and it will allow you to inspect the individual file, then, on the right side of the page there should be a tiny button (next to a button that says "RAW") to download it. -4 Create a folder anywhere in your computer and place the downloaded files inside. Your website will live here. +4. Create a folder anywhere in your computer and place the downloaded files inside. Your website will live here. 5. Create your website as a markdown file, using Pandoc's markdown formattng. [Here is an example file](https://raw.githubusercontent.com/owickstrom/the-monospace-web/refs/heads/main/index.md), compare it to the [live website](https://owickstrom.github.io/the-monospace-web/) to figure out what makes what. You can also [click here](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) to see a more in-depth formatting guide. 6. Open your command line, navigate to your project's folder, and write the following command `pandoc --toc -s --css reset.css --css index.css -i yoursourcefile.md -o output.html --template=template.html` * You'll need to replace the file names with your own. * You can and should automate this process with a batch script. -7. test +7. Congratulations! Open `output.html` to see your built website! +8. There is also a video guide here: XXX todo XXX ## License From 41b7239530b94c11500eac94035c415c25cafa6c Mon Sep 17 00:00:00 2001 From: HugoCortell Date: Tue, 8 Oct 2024 00:53:03 +0200 Subject: [PATCH 9/9] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index dc01171..0c013f7 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,6 @@ make * You'll need to replace the file names with your own. * You can and should automate this process with a batch script. 7. Congratulations! Open `output.html` to see your built website! -8. There is also a video guide here: XXX todo XXX ## License