Output to public/ instead of site/

Author: senekor

.github/workflows/main.yml

@@ -32,12 +32,12 @@ jobs:
       - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
 
       - run: cargo run
-      - run: cp CNAME ./site/
-      - run: touch site/.nojekyll
+      - run: cp CNAME ./public/
+      - run: touch public/.nojekyll
 
       - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
         with:
-          path: site
+          path: public
 
   deploy:
     if: ${{ github.ref == 'refs/heads/master' }}

.gitignore

@@ -2,6 +2,7 @@
 /target/
 **/*.rs.bk
 site
+public
 static/styles/vendor.css
 static/styles/app.css
 static/styles/fonts.css

README.md

@@ -19,11 +19,11 @@ $ cargo run
 
 You could do it in release mode if you'd like, but it's pretty fast in debug.
 
-From there, the generated HTML will be in a `site` directory.
-Open `site/index.html` in your web browser to view the site.
+From there, the generated HTML will be in a `public` directory.
+Open `public/index.html` in your web browser to view the site.
 
 ```console
-$ firefox site/index.html
+$ firefox public/index.html
 ```
 
 You can also run a server, if you need to preview your changes on a different machine:

serve/src/main.rs

@@ -7,7 +7,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let footer = format!("{} {}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
 
     warpy::server::run(
-        format!("{}/../site", env!("CARGO_MANIFEST_DIR")),
+        format!("{}/../public", env!("CARGO_MANIFEST_DIR")),
         [0, 0, 0, 0],
         footer,
         Some(8000),

src/bin/blog.rs

@@ -5,11 +5,11 @@ pub fn main() -> eyre::Result<()> {
 
     println!(
         "blog has been generated; you can now serve its content by running\n\
-              {INDENT}python3 -m http.server --directory {ROOT}/site\n\
+              {INDENT}python3 -m http.server --directory {ROOT}/public\n\
               or running:\n\
               {INDENT}cargo run -p serve\n\
               or you can read it directly by opening a web browser on:\n\
-              {INDENT}file:///{ROOT}/site/index.html",
+              {INDENT}file:///{ROOT}/public/index.html",
         ROOT = env!("CARGO_MANIFEST_DIR"),
         INDENT = "    "
     );

src/lib.rs

@@ -297,7 +297,7 @@ fn copy_dir(source: impl AsRef<Path>, dest: impl AsRef<Path>) -> Result<(), io::
 }
 
 pub fn main() -> eyre::Result<()> {
-    let blog = Generator::new("site", "content")?;
+    let blog = Generator::new("public", "content")?;
 
     blog.render()?;
 
@@ -306,11 +306,11 @@ pub fn main() -> eyre::Result<()> {
 
 #[test]
 fn snapshot() {
-    let _ = std::fs::remove_dir_all(concat!(env!("CARGO_MANIFEST_DIR"), "/site"));
+    let _ = std::fs::remove_dir_all(concat!(env!("CARGO_MANIFEST_DIR"), "/public"));
     main().unwrap();
     let timestamped_files = ["releases.json", "feed.xml"];
     let inexplicably_non_deterministic_files = ["images/2023-08-rust-survey-2022/experiences.png"];
-    insta::glob!("..", "site/**/*", |path| {
+    insta::glob!("..", "public/**/*", |path| {
         if path.is_dir() {
             return;
         }
@@ -335,7 +335,7 @@ fn snapshot() {
         (r"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}", "(filtered timestamp)"),
     ]}, {
         for file in timestamped_files {
-            let content = fs::read(format!("site/{file}")).unwrap();
+            let content = fs::read(format!("public/{file}")).unwrap();
             let content = String::from_utf8_lossy(&content).into_owned();
             insta::assert_snapshot!(content);
         }