| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
|
|
|
| |
Fixes: e9bc86f962 rc scripting article: file naming convention and "instancing"
|
|
|
|
|
|
|
| |
- emphasize the file naming convention and why
- add a section about "instancing"
Reviewed by: Pau Amma (doc/english bits)
Differential Revision: https://reviews.freebsd.org/D45897
|
|
|
|
|
| |
Reviewed by: bcr, fernape
Differential Revision: https://reviews.freebsd.org/D42779
|
|
|
|
|
|
| |
Chapter 11 of the FreeBSD Documentation Project Primer states that
language should be clear, short, and simple. This phrasing rarely helps
with that and can be cut to a single "to" in pretty much all instances.
|
| |
|
|
|
|
|
| |
PR: 259832
Approved by: carlavilla@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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
|
|
|
|
|
|
|
| |
This reverts commit 3462d12db6ebf303064db168a2333374344f369a.
Too soon, it broke asciidoctor-pdf which doesn't know Hugo's shortcode.
It will take more time and care.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This is a prerequisite for the translation workflow through .po files
and Weblate.
The asciidoctor include with the shortcode variable will help because
won't be needed to change the includes manually after converting the
translation (.po file) back to .adoc.
It will help other areas like, language attributes, which today is fixed
in every document.
The use of shortcode was suggested by jmooring@ from Hugo's project on
Github.
Reviewed by: carlavilla
Differential Revision: https://reviews.freebsd.org/D30823
|
|
|
|
|
| |
build.
This fixes the PDF versions.
|
|
|
|
|
|
| |
Add in all articles and books the tag list.
Modify the theme to use the tag list defined in articles and books
to generate the keywords meta tag
|
|
|
|
|
|
|
|
|
|
| |
Also add weights to some, to define the sort order in the index
Put the more commonly used items at the top of their respective lists
The improved descriptions were taken from the old books/articles list:
https://www.freebsd.org/docs/books/
Sponsored-By: Klara Inc.
|
|
|
|
|
|
|
| |
Changes:
- Add the description meta tag in the index, articles and books
- Add a brief description in each article and book.
- Remove the SVN expansion tag
|
|
|
|
|
| |
Global review of styles, typos and images paths
in gjournal-desktop, releng, vinum and vm-design
|
| |
|
|
|
|
| |
Approved by: carlavilla
|
|
|
|
|
|
|
|
| |
The hier(7) man-page lists /usr/share as the location for
architecture-independent files, so fix a few instances where the
documentation referes to /usr/shared instead of /usr/share.
PR: 253760
|
|
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
|