Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
616fe00
Refactor README intro for clarity and layout
RafaelJohn9 May 23, 2025
61b0883
Add detailed Table of Contents for project documentation
RafaelJohn9 May 23, 2025
6fad6bf
Add "Getting Started" section with recommended cloning method
RafaelJohn9 May 23, 2025
000aad3
Remove $ from shell commands to improve copy-pasting
RafaelJohn9 May 23, 2025
b167db0
Add manual sparse clone instructions and remove $ from commands
RafaelJohn9 May 23, 2025
0c06fa8
Refine note on using sparse-checkout with existing full clones
RafaelJohn9 May 23, 2025
5481388
Add detailed directory structure section with descriptions
RafaelJohn9 May 23, 2025
289edb6
Revamp local development section with prerequisites and serving instr…
RafaelJohn9 May 23, 2025
3461aa1
Clarify usage of Hugo’s built-in server with ugly URLs disabled
RafaelJohn9 May 23, 2025
283537a
Add "Enabling Search Locally" section and clean up shell command form…
RafaelJohn9 May 23, 2025
3f0cb77
Update Pagefind server instructions and add note on performance impact
RafaelJohn9 May 23, 2025
d9c5731
Revise Testing section for clarity and improved formatting
RafaelJohn9 May 23, 2025
aaf72d5
Clarify Playwright setup and testing instructions
RafaelJohn9 May 23, 2025
3adf702
Refactor manual pages section for clarity and structure
RafaelJohn9 May 23, 2025
bf34f05
Clarify manual page generation instructions and add localized build s…
RafaelJohn9 May 23, 2025
b33b0f8
Refactor instructions for downloads data and ProGit book updates
RafaelJohn9 May 23, 2025
ef25c49
Improve ProGit book update instructions
RafaelJohn9 May 23, 2025
b5f4412
Improve contribution instructions
RafaelJohn9 May 23, 2025
aee7190
Add detailed instructions for adding new GUI clients
RafaelJohn9 May 23, 2025
1311004
Refactor and enhance Useful Links section
RafaelJohn9 May 23, 2025
863f29f
Improve formatting and clarity of License section
RafaelJohn9 May 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,30 +66,30 @@ git reset --hard

---

- To work on the GitHub workflows that perform the automated, scheduled pre-rendering:
- .github/
## Local Development
Comment on lines -46 to +69
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit (289edb6) is inconsistent. It removes some description of directories that should have been part of 5481388. This reduces the clarity of this PR and makes it quite hard to review.


- The pre-rendered pages (ProGit book, its translated versions, the manual pages, their translated versions):
- external/book/
- external/docs/
You will want to avoid editing these directly, as they contain pages that are pre-rendered via GitHub workflows, sourcing content from other repositories.
### Prerequisites

To render the site locally, you'll need [Hugo](https://gohugo.io/)'s **extended** version v0.128.0 or later. On Windows, we recommend using the Windows Subsystem for Linux (WSL) because some file names contain colons which prevent them from being checked out on Windows file systems.
- [Hugo](https://gohugo.io/), **extended** version v0.128.0 or later.
- [Node.js](https://nodejs.org/).
- On Windows, it is recommended to use Windows Subsystem for Linux (WSL) due to file naming constraints.

You can verify the Hugo version like this:
Verify your Hugo installation:

```console
$ hugo version
hugo v0.128.0+extended linux/amd64 BuildDate=unknown
```

You can serve the site locally via:
### Serving the Site Locally

To serve the site using the provided script:

```console
$ node script/serve-public.js
node script/serve-public.js
```

The site should be running on http://127.0.0.1:5000.
The site will be available at [http://127.0.0.1:5000](http://127.0.0.1:5000).

If you want to serve the site via Hugo's built-in mechanism, you will need to turn off ["ugly URLs"](https://gohugo.io/content-management/urls/#appearance), by running this command, which will serve the site via http://127.0.0.1:1313:

Expand Down