Docs/flatpak
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use new docsbuilder.sh script

Browse source 
The Fedora Documentation team has produced a new, improved local
preview script called docsbuilder.sh. Most imporantly, it watches for
changes and automatically rebuilds the preview. Start using it instead
of the old build.sh and preview.sh.

More information can be found at:
https://gitlab.com/fedora/docs/fedora-linux-documentation/fedora-linux-admin-tools
This commit is contained in:
Otto Liljalaakso 2023-01-21 12:22:07 +02:00
parent 930878e5cb
commit 3ed24b972a
5 changed files with 304 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -4,16 +4,16 @@ This repository documentation for packaging and using Flatpak in Fedora.
## Local preview
This repo includes scripts to build and preview the contents of this repository.
This repo includes a script to build and preview the contents of this repository.
**NOTE**: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.
Both scripts use podman, so please make sure you have it installed on your system.
The script uses podman, so please make sure you have it installed on your system.
To build and preview the site, run:
```
$ ./build.sh && ./preview.sh
$ ./docsbuilder.sh
```
The result will be available at http://localhost:8080. `build.sh` can then be run repeatedly to update the content as you edit it.
The result will be available at http://localhost:8080. Changes are detected automatically and can be viewed by reloading the page.