-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfaq_sample.yml
More file actions
53 lines (42 loc) · 2.26 KB
/
Copy pathfaq_sample.yml
File metadata and controls
53 lines (42 loc) · 2.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Exercises:
# - Plain text, inline code, bold/italic, links, lists, multi-line code blocks
# - Items with and without `category`
# - Multiple items sharing a category (to test grouping)
# - First-appearance category ordering: "Getting Started" -> "Usage" -> "Troubleshooting"
- question: What is AfterPython?
answer: AfterPython is a CLI that automates Python project maintenance and generates a project website from your `afterpython/` content folder.
- question: How do I install it?
answer: Run `pip install afterpython`, then `ap init` inside your project root. See the **[quickstart](/doc/quickstart)** for the full walkthrough.
category: Getting Started
- question: What does `ap init` set up for me?
answer: |
`ap init` configures:
- Pre-commit hooks (ruff, ty)
- Conventional commit message checks (commit types in `afterpython.toml`)
- Semantic-release for versioning
- The project website scaffold under `afterpython/`
category: Getting Started
- question: How do I run the dev server?
answer: |
Use `ap dev` from your project root:
```bash
cd my-project
ap dev
```
This boots the SvelteKit template at `http://localhost:5173`.
category: Usage
- question: Can I write content in Jupyter notebooks?
answer: Yes — `.ipynb` files in `afterpython/tutorials/` or `afterpython/blog/` are auto-converted. *Marimo* notebooks and **MyST Markdown** are also supported.
category: Usage
- question: "Why does `ap build` fail with: `No pyproject.toml found`?"
answer: |
AfterPython locates the project root by walking up from your current directory looking for `pyproject.toml`. Make sure:
1. You're inside a Python project
2. `pyproject.toml` exists at or above your `cwd`
3. You haven't accidentally `cd`'d into a sibling directory
category: Troubleshooting
- question: Does this work without a GitHub repository?
answer: Yes. The website builds fine locally; only `ap release` and GitHub Pages deploys require a remote.
- question: How do I customize the website's styling?
answer: |
The frontend is a SvelteKit app under `afterpython/_website/`. Edit `src/app.css` or any component in `src/lib/components/`. The template uses **Tailwind CSS v4** — see the [Tailwind docs](https://tailwindcss.com/docs).