Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/beginning-pyscript.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ We only assume you know how to use a browser and edit text.
!!! note

The easiest way to get a PyScript development environment and hosting, is
to use [pyscript.com](pyscript.com) in your browser.
to use [pyscript.com](https://pyscript.com) in your browser.

It is a free service that helps you create new projects from templates, and
then edit, preview and deploy your apps with a unique link.

While the core features of [pyscript.com](pyscript.com) will always be
While the core features of [pyscript.com](https://pyscript.com) will always be
free, additional paid-for capabilities directly support and sustain the
PyScript open source project. Commercial and educational support is also
available.
Expand All @@ -35,10 +35,10 @@ All PyScript applications need three things:
how your application works.

Create these files with your favourite code editor on your local file system.
Alternatively, [pyscript.com](pyscript.com) will take away all the pain of
Alternatively, [pyscript.com](https://pyscript.com) will take away all the pain of
organising, previewing and deploying your application.

If you decide to use [pyscript.com](pyscript.com) (recommended for first
If you decide to use [pyscript.com](https://pyscript.com) (recommended for first
steps), once signed in, create a new project by pressing the "+" button on the
left hand side below the site's logo. You'll be presented with a page
containing three columns (listing your files, showing your code and previewing
Expand Down Expand Up @@ -221,22 +221,22 @@ That's it!

### PyScript.com

If you're using [pyscript.com](pyscript.com), you should save all your files
If you're using [pyscript.com](https://pyscript.com), you should save all your files
and click the "run" button. Assuming you've copied the code properly, you
should have a fine old time using "Polyglot 🦜" to translate English to
Pirate-ish.

Alternatively, [click here to see a working example of this app](https://ntoll.pyscriptapps.com/piratical/latest/).
Notice that the bottom right hand corner contains a link to view the code on
[pyscript.com](pyscript.com). Why not explore the code, copy it to your own
[pyscript.com](https://pyscript.com). Why not explore the code, copy it to your own
account and change it to your satisfaction.

### From a web server

Just host the three files (`pyscript.toml`, `index.html`
and `main.py`) in the same directory on a static web server somewhere.

Clearly, we recommend you use [pyscript.com](pyscript.com) for this, but any
Clearly, we recommend you use [pyscript.com](https://pyscript.com) for this, but any
static web host will do (for example,
[GitHub Pages](https://pages.github.com/),
[Amazon's S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteHosting.html),
Expand All @@ -252,4 +252,4 @@ needed to build yet more interesting things of your own.

PyScript is extremely powerful, and these beginner steps only just scratch the
surface. To learn about PyScript in more depth, check out
[our user guide](/user-guide).
[our user guide](user-guide.md).
8 changes: 4 additions & 4 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for wanting to contribute to the PyScript project!

## Code of conduct

The [PyScript Code of Conduct](/conduct) governs the project and everyone
The [PyScript Code of Conduct](conduct.md) governs the project and everyone
participating in it. By participating, you are expected to uphold this code.
Please report unacceptable behavior to the maintainers or administrators as
described in that document.
Expand Down Expand Up @@ -123,17 +123,17 @@ git pull upstream main

PyScrcipt welcomes contributions, suggestions, and feedback. All contributions,
suggestions, and feedback you submitted are accepted under the
[Apache 2.0](/license) license. You represent that if you do not own
[Apache 2.0](license.md) license. You represent that if you do not own
copyright in the code that you have the authority to submit it under the
[Apache 2.0](/license) license. All feedback, suggestions, or contributions
[Apache 2.0](license.md) license. All feedback, suggestions, or contributions
are not confidential.

### Becoming a maintainer

Contributors are invited to be maintainers of the project by demonstrating good
decision making in their contributions, a commitment to the goals of the
project, and consistent adherence to the
[code of conduct](./conduft.md). New maintainers are invited by a 3/4 vote of
[code of conduct](conduct.md). New maintainers are invited by a 3/4 vote of
the existing maintainers.

## Trademarks
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
While we endeavour to write clearly, some of the content in this user guide
will not be suitable for beginners. We assume readers already have Python
or web development experience. If you're a beginner start with our
[beginner's guide](/beginning-pyscript).
[beginner's guide](beginning-pyscript.md).

We [welcome feedback](https://github.com/pyscript/docs/issues) to help us
improve.
Expand All @@ -31,7 +31,7 @@ PyScript, you are welcome to contribute via
[the project's GitHub organisation](https://github.com/pyscript).

Finally, the examples listed at the end of this page are all freely available
and copiously commented on [pyscript.com](pyscript.com).
and copiously commented on [pyscript.com](https://pyscript.com).

!!! note

Expand All @@ -42,7 +42,7 @@ and copiously commented on [pyscript.com](pyscript.com).

## What is PyScript?

[PyScript](pyscript.net) is a platform for [Python](python.org) in the
[PyScript](https://pyscript.net) is a platform for [Python](https://python.org) in the
[browser](https://en.wikipedia.org/wiki/Web_browser).

PyScript brings together two of the most vibrant technical ecosystems on the
Expand Down Expand Up @@ -860,7 +860,7 @@ PyScript uses a feature recently added to web standards called

In order for Atomics to work **you must ensure your web server should enable
the following headers** (this is the default behaviour for
[pyscript.com](pyscript.com)):
[pyscript.com](https://pyscript.com)):

```
Cross-Origin-Opener-Policy: same-origin
Expand Down
3 changes: 0 additions & 3 deletions version.json

This file was deleted.