You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: afterpython/doc/quickstart.md
+26-28Lines changed: 26 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
# Quickstart
7
7
8
-
## Installation and Initialization
8
+
## Install & Initialize
9
9
10
10
```bash
11
11
# install afterpython as a dev dependency
@@ -15,8 +15,6 @@ uv add --dev afterpython
15
15
ap init
16
16
```
17
17
18
-
---
19
-
## Writing Content
20
18
After running `ap init`, the `afterpython/` directory is created and you can start writing content right away.
21
19
22
20
The structure of `afterpython/` is as follows:
@@ -26,37 +24,40 @@ The structure of `afterpython/` is as follows:
26
24
-`afterpython/example/`
27
25
-`afterpython/guide/`
28
26
29
-
All these subdirectories are initialized by `myst init` (see [MyST Markdown]), with a default `index.md` file for each content type.
27
+
---
28
+
## Project Website
29
+
A project website is basically a website that serves as the **homepage for your project**.
30
30
31
-
For example, to start writing documentation of your project, run `ap doc` to start the development server for the `afterpython/doc/` directory, then create a new `.md` or `.ipynb` file in `afterpython/doc/`.
31
+
It aggregates and presents all your content in one place, including documentation, blog posts, tutorials, examples, and how-to guides.
32
32
33
-
You can then view the documentation at `http://localhost:3000/` (or the port specified by `ap doc --port`).
33
+
See [](project_website.md) for more details.
34
34
35
-
Similarly, you can start the development server for other content types by running `ap blog`, `ap tutorial`, `ap example`, or `ap guide`, and then create `.md` or `.ipynb` files in the corresponding directory.
35
+
---
36
+
## Develop
36
37
37
-
:::{seealso}
38
-
To learn more about how to arrange your content, see [Table of Contents] or a [Quick Guide about myst.yml](walkthrough/myst_yml.md).
39
-
:::
38
+
### Starting Development Servers
40
39
41
-
---
42
-
## Project Website
43
-
A project website is basically a website that serves as the **homepage for your project**.
40
+
AfterPython provides two ways to work with content:
44
41
45
-
It sits on top of your content, including documentation, blog posts, tutorials, examples, and guides.
42
+
1.**Project Website Only** - Run `ap dev` to start the development server for your project website.
46
43
47
-
You can run `ap dev` to start the development server for the project website to see how everything looks and works together.
44
+
2.**Individual Content Development** - Run `ap dev` with flags to work on specific content types:
45
+
-`ap dev --doc` - Documentation
46
+
-`ap dev --blog` - Blog posts
47
+
-`ap dev --tutorial` - Tutorials
48
+
-`ap dev --example` - Examples
49
+
-`ap dev --guide` - Guides
50
+
-`ap dev --all` - Everything at once (all content types + project website)
48
51
49
-
Note that this server is **independent** from the development servers for your content — you need to run `ap doc`to start another server for the *Documentation tab* in your website to work.
52
+
When using flags, a MyST development server starts for that specific content folder (e.g., `afterpython/doc/`), allowing you to write and preview content in `.md` or `.ipynb` files with live reload.
50
53
51
-
For convenience, you can run `ap dev --all` to start the development server for all content types and the project website at once, so that you don't need to run `ap doc`, `ap blog`, `ap tutorial`, `ap example`, or `ap guide` separately.
54
+
### Content Organization
52
55
53
-
:::{tip} Standard Workflow
54
-
The typical workflow is:
55
-
- Run `ap doc` (and other content types) and start writing content
56
-
- When finished, run `ap dev --all` to see what the final project website looks like
57
-
:::
56
+
All content folders in `afterpython/` (e.g., `afterpython/doc/`, `afterpython/blog/`) are initialized by `myst init` (see [MyST Markdown]), and **each** has a default `index.md` file and a `myst.yml` file for configuration.
58
57
59
-
See [](project_website.md) for more details.
58
+
:::{seealso}
59
+
To learn more about how to arrange your content in the content folders, see [Table of Contents] or a [Quick Guide about myst.yml](walkthrough/myst_yml.md).
60
+
:::
60
61
61
62
---
62
63
## Build & Preview
@@ -73,14 +74,11 @@ By default, it will be triggered for deployment when you push any content change
73
74
- write content in a different branch, or
74
75
- disable the workflow by commenting out the `on: push` section in the `deploy.yml` file
75
76
77
+
*[MyST] is the document engine that powers `afterpython`. You may want to read the [Quick Guide to MyST](myst.md) to understand what you can do with it before writing content.*
76
78
79
+
---
77
80
:::{important} `afterpython` badge
78
81
To support `afterpython`, consider adding this badge [](https://afterpython.org) to your python project's `README.md` by writing:
[MyST] is the document engine that powers `afterpython`. You may want to read the [Quick Guide to MyST](myst.md) to understand what you can do with it before writing content.
0 commit comments