From nobody Tue May 14 13:47:59 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+67419+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+67419+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1605233560; cv=none; d=zohomail.com; s=zohoarc; b=fawltbT9Hw5F/JUdpblaTzppEyrCI9H4A15o2CS5qMh6ZyskrmdtFvN5ack/Z2GnXeEGEPXs7kVTVXQv31Q49ObvVI8ftML9uQXv5aqPQgmxzK0qryyXK4hXT2WApZet/wkDM8e5g3QOj36NqQxvC6cutt6G4zGv8o/AoCQeIfs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1605233560; h=Content-Transfer-Encoding:Date:From:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Sender:Subject:To; bh=P4DIZxYiR+Af3jNDn2Tkcz+iFb2suST7/wV1LSgB+wU=; b=ENAjobp3DBgdxLpnBHqrzOwc/R+ARMcq1JZDBUsnFhsBgZmtYbfh/H7XlOEbfgGEIzIm2Fr59apu4iTjr/Cz6EoIUz0wbLDgXgN2jAacjFt35yLVjwwZoMLdUGVJW817m7lKxa31x9Nkbo61mR9k+y9kupDjpQY8gbbPW2wBj1k= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+67419+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 160523356041464.25738222968255; Thu, 12 Nov 2020 18:12:40 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id R8l5YY1788612xQlF4kC7Z8V; Thu, 12 Nov 2020 18:12:39 -0800 X-Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by mx.groups.io with SMTP id smtpd.web09.15108.1605233559460200555 for ; Thu, 12 Nov 2020 18:12:39 -0800 IronPort-SDR: YJr2INXOyUC7UkMG9Nnfe2U1jDN7jIk/ZIlQkxB6VPpcdO0wJcY12xkZkFfz6vzpbXq/agPp9R F4buCUNkijrQ== X-IronPort-AV: E=McAfee;i="6000,8403,9803"; a="157434349" X-IronPort-AV: E=Sophos;i="5.77,473,1596524400"; d="scan'208";a="157434349" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Nov 2020 18:12:38 -0800 IronPort-SDR: MFWdRTcPEbrndyBuzq3iq4kashgPUpu9XKtBdWwqIiXNUgq1bkr90hpnkSQ+8cWnjcMA9dqTqn Kdk4NoQCHb2Q== X-IronPort-AV: E=Sophos;i="5.77,473,1596524400"; d="scan'208";a="328717793" X-Received: from mdkinney-mobl2.amr.corp.intel.com ([10.212.84.140]) by orsmga006-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Nov 2020 18:12:38 -0800 From: "Michael D Kinney" To: devel@edk2.groups.io Subject: [edk2-devel] [edk2-CCodingStandardsSpecification/master][Patch] Add Gitbook Action to publish HTML, PDF, EPUB, and MOBI Date: Thu, 12 Nov 2020 18:12:33 -0800 Message-Id: <20201113021233.5156-1-michael.d.kinney@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,michael.d.kinney@intel.com X-Gm-Message-State: elZiPYPvVBpvi7wfmPuRnfaPx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1605233559; bh=no3EiXzSE9rOFAtJ5kasQlDkvSK3Ftkjvu4+JGX/3DE=; h=Date:From:Reply-To:Subject:To; b=Z10k6ruuV3lfkNX+n8cCpR5loIyJa3Tx/kFzHWkYhEWseqNP9ZUdtu9cl7knXIk7SU3 MwH0YYvAzhv7iGAaC43HpoXCJKvgELJvKAIg6hC0VlRrOtj1WySVe5PLbYOSRobF0R084 hUDviYor5Hl+Pz+0FJS7iMsgvY31UfsSFe8= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" Add Gitbook Action to publish this document in the gh-pages branch of the same repository in HTML, PDF, EPUB, and MOBI formats. The draft and release versions of the documents are published in different directories of the gh-pages branch so all published versions are available for download and online viewing. Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney --- .bookignore | 3 +++ .github/workflows/gitbook-action.yml | 39 ++++++++++++++++++++++++++++ .gitignore | 10 +++---- book.json | 3 +-- styles/epub.css | 8 ++++++ styles/mobi.css | 8 ++++++ styles/pdf.css | 8 ++++++ styles/website.css | 8 ++++++ 8 files changed, 80 insertions(+), 7 deletions(-) create mode 100644 .bookignore create mode 100644 .github/workflows/gitbook-action.yml diff --git a/.bookignore b/.bookignore new file mode 100644 index 0000000..ed716f0 --- /dev/null +++ b/.bookignore @@ -0,0 +1,3 @@ +/.github +.gitignore +.bookignore diff --git a/.github/workflows/gitbook-action.yml b/.github/workflows/gitbo= ok-action.yml new file mode 100644 index 0000000..917b0d7 --- /dev/null +++ b/.github/workflows/gitbook-action.yml @@ -0,0 +1,39 @@ +name: 'Gitbook Action Build' +on: + push: + branches: + - master + - release/* + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout action + uses: actions/checkout@v2 + - name: Get Branch + run: | + raw=3D$(git branch -r --contains ${{ github.ref }}) + branch=3D${raw/ origin\/} + pubdir=3D${branch/master/draft} + pubdir=3D${pubdir////-} + echo "ON_PUSH_BRANCH_NAME=3D$branch" >> $GITHUB_ENV + echo "ON_PUSH_PUBDIR=3D$pubdir" >> $GITHUB_ENV + - name: Gitbook Action + uses: zanderzhao/gitbook-action@v1.2.4 + with: + token: ${{secrets.GITBOOK_ACTION_PERSONAL_TOKEN}} + source_branch: ${{env.ON_PUSH_BRANCH_NAME}} + publish_branch: gh-pages + publish_dir: ${{env.ON_PUSH_PUBDIR}} + publish_remove_last_build: true + gitbook_pdf: true + gitbook_pdf_dir: / + gitbook_pdf_name: ${{ github.event.repository.name }}-${{env.ON_PU= SH_PUBDIR}} + gitbook_epub: true + gitbook_epub_dir: / + gitbook_epub_name: ${{ github.event.repository.name }}-${{env.ON_P= USH_PUBDIR}} + gitbook_mobi: true + gitbook_mobi_dir: / + gitbook_mobi_name: ${{ github.event.repository.name }}-${{env.ON_P= USH_PUBDIR}} diff --git a/.gitignore b/.gitignore index 1a366fb..e9c50d9 100644 --- a/.gitignore +++ b/.gitignore @@ -5,12 +5,12 @@ ## Dependency directory ## Commenting this out is preferred by some people, see ## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-i= nto-git -node_modules +/node_modules =20 # Book build output -_book +/_book =20 # eBook build output -*.epub -*.mobi -*.pdf \ No newline at end of file +/book.epub +/book.mobi +/book.pdf \ No newline at end of file diff --git a/book.json b/book.json index 30ea7e0..d112b26 100644 --- a/book.json +++ b/book.json @@ -4,7 +4,6 @@ "title" : "EDK II C Coding Standards Specification", "version" : "Revision 2.2" }, - - "plugins": ["puml"], + "plugins": ["puml-aleung"], "pluginsConfig": {} } diff --git a/styles/epub.css b/styles/epub.css index 2a767f8..fe9d16a 100644 --- a/styles/epub.css +++ b/styles/epub.css @@ -1,3 +1,11 @@ +p { + font-family: sans, sans-serif, Ariel; +} + +body { + font-family: sans, sans-serif, Ariel; +} + h1 { color: #0860A8; font-weight: normal; diff --git a/styles/mobi.css b/styles/mobi.css index 244ec71..81882a1 100644 --- a/styles/mobi.css +++ b/styles/mobi.css @@ -1,3 +1,11 @@ +p { + font-family: sans, sans-serif, Ariel; +} + +body { + font-family: sans, sans-serif, Ariel; +} + h1 { color: #0860A8; font-weight: bold; diff --git a/styles/pdf.css b/styles/pdf.css index 2a767f8..fe9d16a 100644 --- a/styles/pdf.css +++ b/styles/pdf.css @@ -1,3 +1,11 @@ +p { + font-family: sans, sans-serif, Ariel; +} + +body { + font-family: sans, sans-serif, Ariel; +} + h1 { color: #0860A8; font-weight: normal; diff --git a/styles/website.css b/styles/website.css index 2a767f8..fe9d16a 100644 --- a/styles/website.css +++ b/styles/website.css @@ -1,3 +1,11 @@ +p { + font-family: sans, sans-serif, Ariel; +} + +body { + font-family: sans, sans-serif, Ariel; +} + h1 { color: #0860A8; font-weight: normal; --=20 2.29.2.windows.2 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#67419): https://edk2.groups.io/g/devel/message/67419 Mute This Topic: https://groups.io/mt/78221754/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-