Skip to content

docs: explain how to test changes #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexislefebvre wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: explain how to test changes #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,11 @@ hugo
## Dev

In `themes/api-platform` run `npm run build -- --watch`
Run `hugo serve`
Run `hugo serve --watch`

Hugo will share the URL to see the documentation with automatic rebuilding.

You can now perform and test changes:

- the directory `content/` is a clone of https://github.com/api-platform/docs
- the directory `themes/` contain custom theming applied to the documents in `content/`