From nobody Mon Jan 23 14:47:48 2023 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4P0tHm4B2Nz2txxQ for ; Mon, 23 Jan 2023 14:47:48 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4P0tHm2fDFz3mxJ; Mon, 23 Jan 2023 14:47:48 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1674485268; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=wQVEK7xzyTBt/tJptV7ili7LFb5B1YwYMfDBt7ps250=; b=DlXX1Rxh9oy+lnynsIisZ/7dQhAzpPyD6d7O035346j+GcFq6V1/HMBd9aLEjJoqsoHsi7 qbPrkfl4B7q/HBndaSDsmTEC/bkH7ShH2CCFZ7nyobgl9GQX9MnyI+sCsjf8QQwx2YJVxE tTrIjunEE0Q24hMItDdPQcdgJ00OV5JD3By1EdoQLnSMmZjfGR4yBbPdwtX6zdirFB7cpt g3Ebt0o7D3NhkppeL5LkDB0Da+uWma58q38lioN1MMvJaKhHNWdC1O6ak6px+/iQZYmNfQ tueoLFonCFARAPLNhf++NiBVmXoUSxuewko2yHfPES4HGUjtBxUZAxFXa21RcQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1674485268; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=wQVEK7xzyTBt/tJptV7ili7LFb5B1YwYMfDBt7ps250=; b=f6tANZcVnhLGnN5uDyF9QdYI4ExyCqlVeiDiaCLRJw7UyIwigVom5XqHEjvxcBB1hzNYiq vRqKNyqpIizNn5Ly8tyVmGLFYc7q3Wc/PtvPz+anmuWq03jV6mJERaTqDpCuAgJvOoMvG1 cNkbbaJPxF1c0jDdbXv0aQ3eEVwtLNB8uc7Z6CddsJSd+hNNzgfyEvuLeChdALhdFYwuDN 0QfgAGTTfzTYKj3ZaKkW3zNx5yEaNIzYM66T0imDH/7wfeIz5lJGakpqgULgMA3pDpdCj6 Fri0Z3UmKbDEgQW+4SVeA/3jPhpVgWxq1/2tjk+DFzF0v59cSO30oGp6AlefkA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1674485268; a=rsa-sha256; cv=none; b=BueorikO4MjkMmt4f4VUE2jidjKA8JqOB7dk2mVhhjXgTkZAzOsqMGwr9I4nPfskO7cNy4 /idzqrxu0FXSUjuYyH/8nTyH46H48vcq+blr3RrLoL01fHKfvMVGp8ySjAwYEMod0RVHQn 8ll2kGWVMY3fFUUThO4qMqiVkqgtb1Ft5Q4HKcmdjI7mrcKyE3M7NVoG6Zq/V1YBiR9gNo MeNpbUW/4sN4Ri+NWFF1/+qrb88pa1r6IZu8qk920Rwi0ocmrJPAK1EVQ+LrvGLPDzT+9X EIIPo+vcSIodx9AYB9MMf3shobKgEzyIwoP34TcyEhrfQPEDkqf9F9FU05y4aA== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4P0tHm1bCRzYMY; Mon, 23 Jan 2023 14:47:48 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 30NElmiZ072491; Mon, 23 Jan 2023 14:47:48 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 30NElma4072490; Mon, 23 Jan 2023 14:47:48 GMT (envelope-from git) Date: Mon, 23 Jan 2023 14:47:48 GMT Message-Id: <202301231447.30NElma4072490@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: "Danilo G. Baio" Subject: git: 48d419160d - main - fdp-primer/doc-build: Add examples for building html for offline usage List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: dbaio X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 48d419160d94f271405a4989195e3064421711a9 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by dbaio: URL: https://cgit.FreeBSD.org/doc/commit/?id=48d419160d94f271405a4989195e3064421711a9 commit 48d419160d94f271405a4989195e3064421711a9 Author: Danilo G. Baio AuthorDate: 2023-01-23 14:46:43 +0000 Commit: Danilo G. Baio CommitDate: 2023-01-23 14:46:43 +0000 fdp-primer/doc-build: Add examples for building html for offline usage The difference is how Hugo handles links and redirects when generating the output. --- .../content/en/books/fdp-primer/doc-build/_index.adoc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc index 00a9ef5827..260769e4ea 100644 --- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc +++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc @@ -151,6 +151,25 @@ A `hostname` can also be set as base url to Hugo’s internal webserver: .... ==== +[[documentation-build-example-offline]] +.Build documentation in html for offline usage +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make html +.... + +To compress the html output, add `DOC_HTML_ARCHIVE=1`: + +[source,shell] +.... +% cd ~/doc/documentation +% DOC_HTML_ARCHIVE=1 make html +.... +==== + [[doc-build-rendering-pdf]] === Rendering to pdf