aboutsummaryrefslogtreecommitdiff
path: root/shared/lib
Commit message (Collapse)AuthorAgeFilesLines
* [macros]: Report faulting anchor in warningFernando Apesteguía2024-09-231-1/+1
|
* macros: Unbreak buildFernando Apesteguía2024-09-231-1/+1
| | | | Use a warning instead of an error for now.
* macros: Disallow crossref without descriptionFernando Apesteguía2024-09-221-0/+4
| | | | While here, fix the macro documentation in fdp-primer.
* [documentation]: Fix links in all output formatsFernando Apesteguía2024-09-072-13/+20
| | | | | | | | | | | | | Use the crossref: macro for intra-file and intra-book links. This will produce the correct link in Single HTML, Splitted HTML and PDF. Rework the macro to include the PDF special render. While here, briefly document macros. PR: 266107 Reviewed by: bcr@, dbaio@, concussious.bugzilla_runbox.com Differential Revision: https://reviews.freebsd.org/D46480
* PackagesMacro: Extend the syntax to category/name@flavor[pkgname]Li-Wen Hsu2023-03-191-5/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The package macro creates a link to the web interface of the port's origin directory in the ports repository. Extend its usage to cover the case when we want to refer to a speicifed flavor of a port. For example, if we want to refer the aarch64-gcc12 pacakge, in the past we can only specify its origin port, like `pacakge:devel/freebsd-gcc12`, and unable to add the `@aarch64` flavor suffix because it creates a broken link. This change makes it strip the suffix after `@` and accept a parameter of package name as link text. If not provided, use the origin as the original behavior. Thus we can have this kind of notation: package:devel/freebsd-gcc12@aarch64[aarch64-gcc12] which creates linkt to: https://cgit.freebsd.org/ports/tree/devel/freebsd-gcc12/ with link text: aarch64-gcc12 Reviewed by: carlavilla, dbaio Differential Revision: https://reviews.freebsd.org/D39067
* macro/ManPage: Update the address of the manual pagesDanilo G. Baio2023-01-281-1/+1
|
* Fix link references in single bookSergio Carlavilla Delgado2022-12-071-3/+3
| | | | | PR: 262661 Submitted by: grahamperrin@
* Change packages url to point git webSergio Carlavilla Delgado2021-12-041-1/+1
| | | | | PR: 260195 Submitted by: PauAmma <pauamma@gundo.com>
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-033-0/+47
| | | | | | | | | | | | | | | | | | | | | | * Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
* Add gitref macro to reference a git hashSergio Carlavilla Delgado2021-02-132-0/+30
| | | | | | | | | | | | | | | | | | With this extension a git hash can be easily referenced. The porters handbook versions chapter uses this extension as an example in the FreeBSD 14.0 version table. An example of use gitref:hash[repository="src|doc|ports",length=hash-longitude] The repository should be src, doc or ports. And if no length it's specified the macro will use 12 characters of the specified hash. PR: 253050 Submitted by: jhb@
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-257-0/+97
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core