added README and stopped tracking /public.

2026-04-18 01:33:09 -06:00
parent 8a91c27ce9
commit 52f57401dc
425 changed files with 91 additions and 42019 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,90 @@
+# Building The Website
+## Clone Repository
+`git clone https://dev.libertytools.io/adminuser/libertytoolsio.git`
+
+## Run Makefile
+The `Makefile` in the root of the directory will run the following two commands:
+``` bash
+hugo server &
+npx -y pagefind --site public --serve
+```
+The first command will run and compile the `hugo` website and any changes made. The second command will build and re-index the search bar index.
+
+To build the website, simply run
+``` bash
+make run
+```
+in the project root to run those two commands found in the `Makefile`.
+
+
+# Viewing Changes to Website Locally
+After running the `Makefile` you should get an output like this"
+
+``` shell
+hugo server &
+npx -y pagefind --site public --serve
+Watching for changes in /path/to/libertytools_sites/dev_lt/libertytoolsio/{archetypes,content,data,layouts,static,themes}
+Watching for config changes in /path/to/libertytools_sites/dev_lt/libertytoolsio/config.toml, /path/to/libertytools_sites/dev_lt/libertytoolsio/themes/hugo-book/hugo.toml
+Start building sites … 
+hugo v0.151.0-c70ab27ceb841fc9404eab5d2c985ff7595034b7+extended linux/amd64 BuildDate=2025-10-02T13:30:36Z VendorInfo=gohugoio
+
+
+                  │ EN  
+──────────────────┼─────
+ Pages            │  27 
+ Paginator pages  │   0 
+ Non-page files   │  65 
+ Static files     │ 106 
+ Processed images │   0 
+ Aliases          │   0 
+ Cleaned          │   0 
+
+Built in 100 ms
+Environment: "development"
+Serving pages from disk
+Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
+Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) 
+Press Ctrl+C to stop
+
+Running Pagefind v1.5.2 (Extended)
+Running from: "/path/to/libertytools_sites/dev_lt/libertytoolsio"
+Source:       "public"
+Output:       "public/pagefind"
+
+[Walking source directory]
+Found 50 files matching **/*.{html}
+
+[Parsing files]
+Did not find a data-pagefind-body element on the site.
+↳ Indexing all <body> elements on the site.
+
+[Reading languages]
+Discovered 2 languages: en-us, en
+
+[Building search indexes]
+Total: 
+  Indexed 2 languages
+  Indexed 48 pages
+  Indexed 6934 words
+  Indexed 0 filters
+  Indexed 0 sorts
+
+┌─────────────────────────────────────────────────────────────────────────┐
+│  Pagefind found references to the Default UI (pagefind-ui.js)           │
+│  on your site. The Default UI is supported and will continue            │
+│  to work.                                                               │
+│                                                                         │
+│  As of 1.5.0, if you are setting up a new integration, use the          │
+│  Component UI instead. It includes a search modal, better               │
+│  accessibility and customization: https://pagefind.app/docs/search-ui/  │
+└─────────────────────────────────────────────────────────────────────────┘
+
+Finished in 0.067 seconds
+
+Serving the Pagefind Playground at http://localhost:1414/pagefind/playground/
+Serving "public" at http://localhost:1414
+```
+
+Copy `http://localhost:1414` into your web browser and you should then see the website as it is with all the changes made, but only served from your local machine. This version of the site is not public facing.
+
+