Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.13
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,33 @@ This Bash Style Guide provides detailed recommendations for writing safe and pre

You are encouraged to fork this repository for your own use and contribute to its improvements.

## Requirements

- Python 3.10 or higher ([Download Python](https://www.python.org/downloads/))
- [uv](https://github.com/astral-sh/uv#installation) (a fast Python package manager and resolver)

## Quick Start

To preview the Bash Style Guide locally:

1. Install [uv](https://github.com/astral-sh/uv#installation) (a fast Python package manager and resolver).
2. Install dependencies:
1. Ensure you have Python 3.10+ installed.
2. Install [uv](https://github.com/astral-sh/uv#installation).
3. Install dependencies:
```bash
uv sync
```
3. Start the development server:
4. Start the development server:
```bash
uv run mkdocs serve
```
4. Open [http://localhost:8000](http://localhost:8000) in your browser.
5. Open [http://localhost:8000](http://localhost:8000) in your browser.

Or, visit the hosted version at [bsg.hthompson.dev](https://bsg.hthompson.dev).

## Project Structure

- `docs/` — Main documentation content (guidelines, changelog, etc.)
- `stylesheets/` — Custom CSS for the site
- `docs/stylesheets/` — Custom CSS for the site
- `overrides/` — MkDocs Material theme overrides
- `mkdocs.yml` — MkDocs configuration

Expand Down
14 changes: 3 additions & 11 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
[project]
name = "bash-style-guide"
version = "2025.7.15"
requires-python = "~=3.12"
description = "A comprehensive style guide and documentation resource for writing robust, readable, and maintainable Bash scripts."
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
"mkdocs-git-revision-date-localized-plugin==1.4.7",
"mkdocs-material==9.6.16",
"mkdocs-exclude==1.0.2",
]

[dependency-groups]
dev = []

[tool.uv]
package = false

[[tool.uv.index]]
name = "pypi"
url = "https://pypi.org/simple"
Loading