You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2020/06/18 05:43:59 UTC
[pdfbox-docs] branch master updated (f03f91f -> 49b577e)
This is an automated email from the ASF dual-hosted git repository.
msahyoun pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git.
from f03f91f PDFBOX-4848: remove instructions for Jekyll based build; add node.js
new f530d84 PDFBOX-4848: remove Jekyll config from repository
new 49b577e PDFBOX-4848: document preview mode; document HTML validation
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
_config.yml | 22 ----------------------
content/siteupdate.md | 19 +++++++++++++++++++
2 files changed, 19 insertions(+), 22 deletions(-)
delete mode 100644 _config.yml
[pdfbox-docs] 02/02: PDFBOX-4848: document preview mode;
document HTML validation
Posted by ms...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
msahyoun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git
commit 49b577ebc2dc2b108025d1d559bd0c4966f4194d
Author: Maruan Sahyoun <sa...@fileaffairs.de>
AuthorDate: Thu Jun 18 07:39:23 2020 +0200
PDFBOX-4848: document preview mode; document HTML validation
---
content/siteupdate.md | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/content/siteupdate.md b/content/siteupdate.md
index cc642ce..1954421 100644
--- a/content/siteupdate.md
+++ b/content/siteupdate.md
@@ -55,6 +55,25 @@ $ npm install # needed only once, or if dependencies change
$ npm run build # to perform the build
~~~
+### Preview Changes
+
+While changing the content the website generation can be done in **Preview** mode. This will fire up a little webserver and update the browser window when there are changes so these are reflected immediately.
+~~~
+$ npm install # needed only once, or if dependencies change
+$ npm run preview # to start the preview mode
+~~~
+
+### Validate the generated files
+
+To validate the generated website document go to the project root directory and run:
+
+~~~
+$ npm run checks
+~~~
+
+This will validate the generated HTML for conformance to the specification as well as run accessibility tests. Testing is done using [HTML-validate](https://html-validate.org/).
+
+
### Publish the Website (For Comitters Only)
After you have done the local changes follow these steps to publish the content:
[pdfbox-docs] 01/02: PDFBOX-4848: remove Jekyll config from
repository
Posted by ms...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
msahyoun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git
commit f530d84b1b902b8e98c037f44d0db41117239dc3
Author: Maruan Sahyoun <sa...@fileaffairs.de>
AuthorDate: Thu Jun 18 07:26:56 2020 +0200
PDFBOX-4848: remove Jekyll config from repository
---
_config.yml | 22 ----------------------
1 file changed, 22 deletions(-)
diff --git a/_config.yml b/_config.yml
deleted file mode 100644
index 8a5264b..0000000
--- a/_config.yml
+++ /dev/null
@@ -1,22 +0,0 @@
-# Site settings
-title: Apache PDFBox | A Java PDF Library
-description: > # this means to ignore newlines until "baseurl:"
- The Apache PDFBox™ library is an open source Java tool for working with PDF documents.
- This project allows creation of new PDF documents, manipulation of existing documents
- and the ability to extract content from documents. Apache PDFBox also includes several
- command-line utilities. Apache PDFBox is published under the Apache License v2.0.
-baseurl: ""
-url: "https://pdfbox.apache.org/"
-
-
-# Build settings
-source: ./content
-destination: ./staging/content
-layouts_dir: _layouts
-
-permalink: /news/:year/:month/:day/:title.html
-
-markdown_ext: "markdown,mkdown,mkdn,mkd,md,mdtext"
-
-encoding: UTF-8
-markdown: kramdown