From nobody Mon May 13 21:21:58 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+67420+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+67420+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1605233569; cv=none; d=zohomail.com; s=zohoarc; b=kNohdt+mYGLYD8LJ1D7JYBTJAriKv4EMGp/TjZbx5diJ09Z82+eWyMmxMdkHGzJR9yfkpvz5BJSdymR0mLyUen0rtL6Dq7vkWz4RVqsBuODpg56bMvFlnyJbVWTE0O77FvFJYT8Wu0TG/zKR985YocPG2puGN0e+3IDV0grG9VM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1605233569; h=Content-Transfer-Encoding:Date:From:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Sender:Subject:To; bh=/eTpA1PP4MuoeZf9MUoxHtG5PTPwLl18Uu4zrCwyXpQ=; b=lUbk6Hv/xTk+k8AgmTX8jMLeCw1GJeOCPzCC9xIb0fvGHENtoyLtVgORLs7zhowBhs/kTGS8TYf9AvZXO0C/a4iQ6Emfhszt9wPc+jo8IYj7sfyZOyEcaGBjaUsVDC8yNR8gYnKWNzo/zshASfTb6mrPJSqIBVjGkjs65ptyLtM= 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+67420+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 1605233569749836.6187733445576; Thu, 12 Nov 2020 18:12:49 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id GPAKYY1788612xnERw97vjCK; Thu, 12 Nov 2020 18:12:49 -0800 X-Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mx.groups.io with SMTP id smtpd.web11.14925.1605233569047448213 for ; Thu, 12 Nov 2020 18:12:49 -0800 IronPort-SDR: Hx8UlPyPSIIg8DJny0ns2n7OYv4DBIU9w2mIvLeLxrIHCMSeGiP0P/f/P/mCk3gTz/C0OVD8pC TbmNr3J9Y3pw== X-IronPort-AV: E=McAfee;i="6000,8403,9803"; a="188424950" X-IronPort-AV: E=Sophos;i="5.77,473,1596524400"; d="scan'208";a="188424950" 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 fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Nov 2020 18:12:48 -0800 IronPort-SDR: 3kLr+vfPioTWhD6FAchbaKiPDURdpi0ifo70OPqUV86oxtVof272lBWOWi4J5zqmMXIlcqZBVp Zv2T524sXnOQ== X-IronPort-AV: E=Sophos;i="5.77,473,1596524400"; d="scan'208";a="328717823" 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:48 -0800 From: "Michael D Kinney" To: devel@edk2.groups.io Subject: [edk2-devel] [edk2-CCodingStandardsSpecification/release/2.20][Patch] Add Gitbook Action to publish HTML, PDF, EPUB, and MOBI Date: Thu, 12 Nov 2020 18:12:44 -0800 Message-Id: <20201113021244.5209-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: 6gg9uLxpMlr56dSgCPsGty9Wx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1605233569; bh=RvfbmBzZm/vXuFw8WUYMWAeao6vnMbH/Runa2/cpk5g=; h=Date:From:Reply-To:Subject:To; b=nWPwLGcAEKoVoP3UHV8I3wgp8lvb8YaDm+vO8zqi9f9rvzu+wrUCR9662E4ThQCj/j5 g0ZDYkVxnvH3EQFwEUTW7iF0HxHqyLjv9qGf+bSik5GW1nToY1pjWRbmjsd3yvQK2cfWO lOuczPyrpvEoEtqe2fJF+X8GFo7ND7/rn1A= 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 39f6413..017d837 100644 --- a/book.json +++ b/book.json @@ -3,7 +3,6 @@ "title" : "EDK II C Coding Standards Specification", "version" : "Revision 2.20" }, - - "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 (#67420): https://edk2.groups.io/g/devel/message/67420 Mute This Topic: https://groups.io/mt/78221756/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-