From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by mx.groups.io with SMTP id smtpd.web11.14984.1605233881494595250 for ; Thu, 12 Nov 2020 18:18:01 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.43, mailfrom: michael.d.kinney@intel.com) IronPort-SDR: GHLKyatswHw+TtuZqK/j8HISNEqYeriRM8Eksv3yhrw1UHSPv2OliXxFnxMukgdnsu5ELN5dzt wT5MrrXqVnHA== X-IronPort-AV: E=McAfee;i="6000,8403,9803"; a="255124981" X-IronPort-AV: E=Sophos;i="5.77,473,1596524400"; d="scan'208";a="255124981" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Nov 2020 18:18:01 -0800 IronPort-SDR: ZxsfRqtlnmQoej4ZnkMKZaCUVMjnYZfjuNkGi4yakILUAJvFwSsIPEnVi77v/QDofQHqh+Y9XD s9RZFFNwbENg== X-IronPort-AV: E=Sophos;i="5.77,473,1596524400"; d="scan'208";a="328719709" 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:18:00 -0800 From: "Michael D Kinney" To: devel@edk2.groups.io Subject: [edk2-ModuleWriteGuide/master][Patch] Add Gitbook Action to publish HTML, PDF, EPUB, and MOBI Date: Thu, 12 Nov 2020 18:17:57 -0800 Message-Id: <20201113021757.6759-1-michael.d.kinney@intel.com> X-Mailer: git-send-email 2.29.2.windows.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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/gitbook-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=$(git branch -r --contains ${{ github.ref }}) + branch=${raw/ origin\/} + pubdir=${branch/master/draft} + pubdir=${pubdir////-} + echo "ON_PUSH_BRANCH_NAME=$branch" >> $GITHUB_ENV + echo "ON_PUSH_PUBDIR=$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_PUSH_PUBDIR}} + gitbook_epub: true + gitbook_epub_dir: / + gitbook_epub_name: ${{ github.event.repository.name }}-${{env.ON_PUSH_PUBDIR}} + gitbook_mobi: true + gitbook_mobi_dir: / + gitbook_mobi_name: ${{ github.event.repository.name }}-${{env.ON_PUSH_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-into-git -node_modules +/node_modules # Book build output -_book +/_book # 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 d87fe8a..5ade228 100644 --- a/book.json +++ b/book.json @@ -4,7 +4,6 @@ "title" : "EDK II Module Writer's Guide", "version" : "Revision 0.71" }, - - "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; -- 2.29.2.windows.2