Skip to content

Commit 6f25f96

Browse files
pawamoypawamoy
committed
feat: Initial commit
0 parents  commit 6f25f96

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+2596
-0
lines changed

‎.copier-answers.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: 1.5.6
3+
_src_path: gh:pawamoy/copier-uv
4+
author_email: dev@pawamoy.fr
5+
author_fullname: Timothée Mazzucotelli
6+
author_username: pawamoy
7+
copyright_date: '2025'
8+
copyright_holder: Timothée Mazzucotelli
9+
copyright_holder_email: dev@pawamoy.fr
10+
copyright_license: ISC License
11+
insiders: false
12+
project_description: MkDocs plugin to generate an /llms.txt file.
13+
project_name: mkdocs-llmstxt
14+
python_package_command_line_name: ''
15+
python_package_distribution_name: mkdocs-llmstxt
16+
python_package_import_name: mkdocs_llmstxt
17+
repository_name: mkdocs-llmstxt
18+
repository_namespace: pawamoy
19+
repository_provider: github.com
20+

‎.envrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
PATH_add scripts

‎.github/FUNDING.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
github: pawamoy
2+
ko_fi: pawamoy
3+
polar: pawamoy
4+
custom:
5+
- https://www.paypal.me/pawamoy

‎.github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve.
4+
title: "bug: "
5+
labels: unconfirmed
6+
assignees: [pawamoy]
7+
---
8+
9+
### Description of the bug
10+
<!-- Please provide a clear and concise description of what the bug is. -->
11+
12+
### To Reproduce
13+
<!-- Please provide a Minimal Reproducible Example (MRE) if possible.
14+
Try to boil down the problem to a few lines of code.
15+
Your code should run by simply copying and pasting it.
16+
17+
Example:
18+
19+
```
20+
git clone https://github.com/username/repro
21+
cd repro
22+
python -m venv .venv
23+
. .venv/bin/activate
24+
pip install -r requirements.txt
25+
... # command or code showing the issue
26+
```
27+
-->
28+
29+
```
30+
WRITE MRE / INSTRUCTIONS HERE
31+
```
32+
33+
### Full traceback
34+
<!-- Please provide the full error message / traceback if any, by pasting it in the code block below.
35+
No screenshots! -->
36+
37+
<details><summary>Full traceback</summary>
38+
39+
```python
40+
PASTE TRACEBACK HERE
41+
```
42+
43+
</details>
44+
45+
### Expected behavior
46+
<!-- Please provide a clear and concise description of what you expected to happen. -->
47+
48+
### Environment information
49+
<!-- Please run the following command in your repository and paste its output below it,
50+
redacting sensitive information. -->
51+
52+
```bash
53+
python -m mkdocs_llmstxt.debug # | xclip -selection clipboard
54+
```
55+
56+
PASTE MARKDOWN OUTPUT HERE
57+
58+
### Additional context
59+
<!-- Add any other relevant context about the problem here,
60+
like links to other issues or pull requests, screenshots, etc.
61+
-->

‎.github/ISSUE_TEMPLATE/2-feature.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project.
4+
title: "feature: "
5+
labels: feature
6+
assignees: pawamoy
7+
---
8+
9+
### Is your feature request related to a problem? Please describe.
10+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. -->
11+
12+
### Describe the solution you'd like
13+
<!-- A clear and concise description of what you want to happen. -->
14+
15+
### Describe alternatives you've considered
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
17+
18+
### Additional context
19+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/3-docs.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Documentation update
3+
about: Point at unclear, missing or outdated documentation.
4+
title: "docs: "
5+
labels: docs
6+
assignees: pawamoy
7+
---
8+
9+
### Is something unclear, missing or outdated in our documentation?
10+
<!-- A clear and concise description of what the documentation issue is. Ex. I can't find an explanation on feature [...]. -->
11+
12+
### Relevant code snippets
13+
<!-- If the documentation issue is related to code, please provide relevant code snippets. -->
14+
15+
### Link to the relevant documentation section
16+
<!-- Add a link to the relevant section of our documentation, or any addition context. -->

‎.github/ISSUE_TEMPLATE/4-change.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Change request
3+
about: Suggest any other kind of change for this project.
4+
title: "change: "
5+
assignees: pawamoy
6+
---
7+
8+
### Is your change request related to a problem? Please describe.
9+
<!-- A clear and concise description of what the problem is. -->
10+
11+
### Describe the solution you'd like
12+
<!-- A clear and concise description of what you want to happen. -->
13+
14+
### Describe alternatives you've considered
15+
<!-- A clear and concise description of any alternative solutions you've considered. -->
16+
17+
### Additional context
18+
<!-- Add any other context or screenshots about the change request here. -->

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: I have a question / I need help
4+
url: https://github.com/pawamoy/mkdocs-llmstxt/discussions/new?category=q-a
5+
about: Ask and answer questions in the Discussions tab.

‎.github/workflows/ci.yml

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
pull_request:
6+
branches:
7+
- main
8+
9+
defaults:
10+
run:
11+
shell: bash
12+
13+
env:
14+
LANG: en_US.utf-8
15+
LC_ALL: en_US.utf-8
16+
PYTHONIOENCODING: UTF-8
17+
PYTHON_VERSIONS: ""
18+
19+
jobs:
20+
21+
quality:
22+
23+
runs-on: ubuntu-latest
24+
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
30+
fetch-tags: true
31+
32+
- name: Set up Pandoc
33+
uses: r-lib/actions/setup-pandoc@v2
34+
35+
- name: Setup Python
36+
uses: actions/setup-python@v5
37+
with:
38+
python-version: "3.12"
39+
40+
- name: Setup uv
41+
uses: astral-sh/setup-uv@v3
42+
with:
43+
enable-cache: true
44+
cache-dependency-glob: pyproject.toml
45+
46+
- name: Install dependencies
47+
run: make setup
48+
49+
- name: Check if the documentation builds correctly
50+
run: make check-docs
51+
52+
- name: Check the code quality
53+
run: make check-quality
54+
55+
- name: Check if the code is correctly typed
56+
run: make check-types
57+
58+
- name: Check for breaking changes in the API
59+
run: make check-api
60+
61+
tests:
62+
63+
strategy:
64+
matrix:
65+
os:
66+
- ubuntu-latest
67+
- macos-latest
68+
- windows-latest
69+
python-version:
70+
- "3.9"
71+
- "3.10"
72+
- "3.11"
73+
- "3.12"
74+
- "3.13"
75+
- "3.14"
76+
resolution:
77+
- highest
78+
- lowest-direct
79+
exclude:
80+
- os: macos-latest
81+
resolution: lowest-direct
82+
- os: windows-latest
83+
resolution: lowest-direct
84+
runs-on: ${{ matrix.os }}
85+
continue-on-error: ${{ matrix.python-version == '3.14' }}
86+
87+
steps:
88+
- name: Checkout
89+
uses: actions/checkout@v4
90+
with:
91+
fetch-depth: 0
92+
fetch-tags: true
93+
94+
- name: Set up Pandoc
95+
uses: r-lib/actions/setup-pandoc@v2
96+
97+
- name: Setup Python
98+
uses: actions/setup-python@v5
99+
with:
100+
python-version: ${{ matrix.python-version }}
101+
allow-prereleases: true
102+
103+
- name: Setup uv
104+
uses: astral-sh/setup-uv@v3
105+
with:
106+
enable-cache: true
107+
cache-dependency-glob: pyproject.toml
108+
cache-suffix: py${{ matrix.python-version }}
109+
110+
- name: Install dependencies
111+
env:
112+
UV_RESOLUTION: ${{ matrix.resolution }}
113+
run: make setup
114+
115+
- name: Run the test suite
116+
run: make test

‎.github/workflows/release.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: release
2+
3+
on: push
4+
permissions:
5+
contents: write
6+
7+
jobs:
8+
release:
9+
runs-on: ubuntu-latest
10+
if: startsWith(github.ref, 'refs/tags/')
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
fetch-tags: true
17+
- name: Setup Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: "3.12"
21+
- name: Setup uv
22+
uses: astral-sh/setup-uv@v3
23+
- name: Prepare release notes
24+
run: uv tool run git-changelog --release-notes > release-notes.md
25+
- name: Create release
26+
uses: softprops/action-gh-release@v2
27+
with:
28+
body_path: release-notes.md

0 commit comments

Comments
 (0)