Commit Graph

7 Commits

Author SHA1 Message Date
Fernando Apesteguía af92816e18 [macros]: Report faulting anchor in warning 2024-09-23 18:11:45 +02:00
Fernando Apesteguía b19f1b1894 macros: Unbreak build
Use a warning instead of an error for now.
2024-09-23 07:23:37 +02:00
Fernando Apesteguía 7c2eef6968 macros: Disallow crossref without description
While here, fix the macro documentation in fdp-primer.
2024-09-22 19:35:28 +02:00
Fernando Apesteguía 557464e66e [documentation]: Fix links in all output formats
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
2024-09-07 20:02:30 +02:00
Sergio Carlavilla Delgado 22d9c0d697 Fix link references in single book
PR:             262661
Submitted by:   grahamperrin@
2022-12-07 19:22:10 +01:00
Sergio Carlavilla Delgado 64acd169b8 Build offline documentation using Hugo and other improvements
* 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
2021-11-03 17:44:52 +01:00
Sergio Carlavilla Delgado 989d921f5d Migrate doc to Hugo/AsciiDoctor
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
2021-01-26 00:31:29 +01:00