Skip to content

Commit 4422cac

Browse files
committed
A more complete README.
1 parent b926968 commit 4422cac

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,27 @@
22

33
Welcome to the PyScript documentation repository.
44

5+
This source code becomes the official PyScript documentation hosted here:
6+
7+
[https://docs.pyscript.net](https://docs.pyscript.net/)
8+
59
Contribute prose and participate in discussions about the written support of
610
PyScript and related topics.
711

812
## Getting started
913

1014
Before you start contributing to the documentation, it's worthwhile to
11-
take a look at the general contributing guidelines for the PyScript project. You can find these guidelines here
15+
take a look at the general contributing guidelines for the PyScript project.
16+
You can find these guidelines here
1217
[Contributing Guidelines](https://github.com/pyscript/pyscript/blob/main/CONTRIBUTING.md)
1318

1419
## Setup
1520

1621
The `docs` directory in the pyscript repository contains a
17-
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) documentation project. Material is a system
18-
that takes plaintext files containing documentation written in Markdown, along with
19-
static files like templates and themes, to build the static end result.
22+
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
23+
documentation project. Material is a system that takes plaintext files
24+
containing documentation written in Markdown, along with static files like
25+
templates and themes, to build the static end result.
2026

2127
To setup the documentation development environment simply create a new
2228
virtual environment, then `pip install -r requirements.txt` (from in the root
@@ -35,19 +41,22 @@ Simply run `mkdocs serve` or `./bin/mkdocs serve`.
3541

3642
## Cross-referencing
3743

38-
You can link to other pages in the documentation by using the `{doc}` role. For example, to link to the `docs/README.md` file, you would use:
44+
Link to other pages in the documentation by using the `{doc}` role. For
45+
example, to link to the `docs/README.md` file, you would use:
3946

4047
```markdown
4148
{doc}`docs/README.md`
4249
```
4350

44-
You can also cross-reference the python glossary by using the `{term}` role. For example, to link to the `iterable` term, you would use:
51+
Cross-reference the Python glossary by using the `{term}` role. For example, to
52+
link to the `iterable` term, you would use:
4553

4654
```markdown
4755
{term}`iterable`
4856
```
4957

50-
You can also cross-reference functions, methods or data attributes by using the `{attr}` for example:
58+
Cross-reference functions, methods or data attributes by using the `{attr}` for
59+
example:
5160

5261
```markdown
5362
{py:func}`repr`

0 commit comments

Comments
 (0)