Skip to content
This repository was archived by the owner on Apr 5, 2026. It is now read-only.

Commit 0b35e1d

Browse files
author
phernandez
committed
docs: add CHANGELOG to docs site
1 parent 46ff298 commit 0b35e1d

4 files changed

Lines changed: 106 additions & 10 deletions

File tree

docs/content/docs/changelog.md

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,100 @@ description: Latest updates and announcements.
44
---
55

66
<Prose>
7-
Coming soon
7+
## v0.1.7 (2024-11-15)
8+
9+
### Bug Fixes
10+
11+
- Update tag for semantic-release action
12+
([`ebd48b3`](https://github.com/basicmachines-co/basic-components/commit/ebd48b3261dc9718eefd315d26a500255d8ed387))
13+
- Push to pypi and github. Install uv in build_command for semantic_release
14+
([`e29837f`](https://github.com/basicmachines-co/basic-components/commit/e29837f4f7b6906ce70003edd898a5cb39c313f6))
15+
- Add uv to docker image for release
16+
([`084c008`](https://github.com/basicmachines-co/basic-components/commit/084c00804d1fc834f1fb5a40fcc25d93ce5c99e7))
17+
- Redo release workflow based on python-semantic-release docs
18+
([`b03dd50`](https://github.com/basicmachines-co/basic-components/commit/b03dd504c013f8c9f1622248f43c1d7f26d92618))
19+
20+
21+
## v0.1.6 (2024-11-15)
22+
23+
### Chores
24+
25+
- Fix github release workflow
26+
([`2f4092e`](https://github.com/basicmachines-co/basic-components/commit/2f4092ecf68cd6d77a71d88f018783a2016c813a))
27+
- Update intallation docs and README
28+
([`ba44c67`](https://github.com/basicmachines-co/basic-components/commit/ba44c67df0b240301819d4e806def7bf5fc5472c))
29+
30+
## v0.1.5 (2024-11-14)
31+
32+
### Chores
33+
34+
- Fix version_toml for semantic_release
35+
([`6e5ef7d`](https://github.com/basicmachines-co/basic-components/commit/6e5ef7d9364abedf40feb2e0b1a205c967aa7903))
36+
37+
38+
## v0.1.4 (2024-11-14)
39+
40+
### Chores
41+
42+
- Fix pyproject toml for semantic_release
43+
([`7db428a`](https://github.com/basicmachines-co/basic-components/commit/7db428a925db897e172df80136cf5d3daf7eb446))
44+
45+
## v0.1.3 (2024-11-14)
46+
47+
### Chores
48+
49+
- Fix github release workflow
50+
([`6210da8`](https://github.com/basicmachines-co/basic-components/commit/6210da8d82dd4daced77560b70a3af9e1e80c408))
51+
52+
## v0.1.2 (2024-11-14)
53+
54+
### Chores
55+
56+
- Add github actions release workflow
57+
([`f32e6fe`](https://github.com/basicmachines-co/basic-components/commit/f32e6fe98e5766f9403e6d35044fb801a36f4e14))
58+
- More doc updates for cli and utils functions
59+
([`5ad08fb`](https://github.com/basicmachines-co/basic-components/commit/5ad08fb315b71990d3af78d4f73337f9950994d2))
60+
61+
62+
## v0.1.1 (2024-11-14)
63+
64+
### Chores
65+
66+
- Update docs for installing, using cli
67+
([`d481aef`](https://github.com/basicmachines-co/basic-components/commit/d481aef15e36bf18ce05e21b250b14a3a7a5b7df))
68+
- Update llms.md for components cli tool
69+
([`a1632d8`](https://github.com/basicmachines-co/basic-components/commit/a1632d81f6466380fda41d474e8a063e59485704))
70+
- Update example projects
71+
([`a2981a5`](https://github.com/basicmachines-co/basic-components/commit/a2981a527e7a9f13dba7bce2e5f42a85341a7cb7))
72+
- More docs cleanup for installing basic-components
73+
([`7b2ac4c`](https://github.com/basicmachines-co/basic-components/commit/7b2ac4c6ab81751774b9127aa6badf6697384b36))
74+
- Remove Jinja from frameworks in pyproject.toml
75+
([`70554ca`](https://github.com/basicmachines-co/basic-components/commit/70554cac5c33cad2230b2db74c366a8135ca479c))
76+
- Update pyproject.toml and README to include dependency groups
77+
([`022d452`](https://github.com/basicmachines-co/basic-components/commit/022d4522de88d35a0bda9009d87b55ee0661e45b))
78+
- Add usage docs for the components cli
79+
([`fae648b`](https://github.com/basicmachines-co/basic-components/commit/fae648bd2c697dbea2908af4aa88fcba7c0fef67))
80+
- Upate docs for components cli
81+
([`05d6ee4`](https://github.com/basicmachines-co/basic-components/commit/05d6ee4e8fe96ea0f6f2448f5a60c1de716ae508))
82+
83+
### Features
84+
85+
- Integrate basic-components utilities and refactor setup
86+
([#8](https://github.com/basicmachines-co/basic-components/pull/8),
87+
[`90b5d2e`](https://github.com/basicmachines-co/basic-components/commit/90b5d2e6cef39f8f4d03a1e4d2e4f0eedec9f0d8))
88+
* feat: integrate basic-components utilities and refactor setup
89+
90+
Introduce `setup_component_catalog` and Tailwind utilities. Add dependency `basic-components` to
91+
examples, refactor `setup_component_catalog` usage, and add `tw` to Jinja globals.
92+
93+
* feat(tailwind): enhance class merging logic and improve docs
94+
95+
Enhance `tw` function to handle class conflicts and maintain consistent ordering. Update
96+
documentation with advanced component patterns, including state management, event handling, and
97+
styling best practices.
98+
99+
---------
100+
101+
Co-authored-by: phernandez <phernandez@basicmachines.co>
102+
8103
</Prose>

docs/markdown.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from docs.templates import templates
88

99

10-
def create_markdown(examples=None):
10+
def create_markdown():
1111
extensions = [
1212
"pymdownx.superfences",
1313
"pymdownx.blocks.tab",
@@ -58,6 +58,7 @@ def create_markdown(examples=None):
5858
}
5959
return markdown.Markdown(extensions=extensions, extension_configs=extension_configs)
6060

61+
md = create_markdown()
6162

6263
def parse_jinja_markdown(file_path: Path):
6364
with open(file_path, "r", encoding="utf-8") as f:
@@ -66,9 +67,7 @@ def parse_jinja_markdown(file_path: Path):
6667

6768
metadata = post.metadata
6869
stripped_content = post.content
69-
examples = metadata.get("examples", [])
7070

71-
md = create_markdown(examples=examples)
7271
html_content = md.convert(stripped_content)
7372
toc = md.toc # pyright: ignore [reportAttributeAccessIssue]
7473

docs/templates.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import arel
66

77
import jinjax
8+
import markdown
89
from icecream import ic
910
from jinja2 import pass_context
1011
from jinja2.ext import DebugExtension
@@ -32,10 +33,11 @@
3233

3334

3435
@pass_context
35-
def include_file(context, path):
36+
def include_file(context, path, skip_lines=0):
3637
try:
3738
with open(Path(path), "r", encoding="utf-8") as f:
38-
return f.read()
39+
lines = f.readlines()
40+
return ''.join(lines[skip_lines:])
3941
except FileNotFoundError:
4042
return f"<!-- {path} not found -->"
4143

@@ -52,7 +54,7 @@ def filename(value):
5254
templates.env.globals["DEBUG"] = docs.config.settings.ENVIRONMENT == "local"
5355
templates.env.filters["include_file"] = include_file
5456
templates.env.filters["filename"] = filename
55-
templates.env.filters["include_file"] = include_file
57+
templates.env.filters["markdown"] = lambda text: markdown.Markdown().convert(text)
5658
templates.env.autoescape = False
5759

5860
# Add cn to globals
@@ -74,7 +76,7 @@ def filename(value):
7476
def template(
7577
request: Request,
7678
name: str,
77-
context: dict,
79+
context: dict = {},
7880
status_code: int = 200,
7981
headers: typing.Optional[typing.Mapping[str, str]] = None,
8082
**kwargs,

docs/templates/components/IncludeFile.jinja

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{# def
2-
dir: str,
3-
file_name: str = "docs/templates",
2+
dir: str = "docs/templates",
3+
file_name: str,
44
lang: str = "html"
55
#}
66

0 commit comments

Comments
 (0)