Giter Site home page Giter Site logo

documents's Introduction

Overview

This repository contains a copy, in Kramdown format, of three documents produced by the CA/Browser Forum: Baseline Requirements, Bylaws, and EV SSL Certificate Guidelines. The master branch is intended to always match the current adopted version of all documents.

As updates are made to the master branch, they are automatically made available at these URLs:

The HTML format is usable either in a browser or in Microsoft Word.

Building

The build process involves generating HTML documents from kramdown, then generating PDF documents from HTML using Weasyprint. These have a number of other dependencies that can be time-consuming to install. The fastest way to start is to use a Docker image, which works on Windows and macOS, and Linux:

git clone https://github.com/cabforum/documents/
cd documents
docker run --rm --volume $PWD:/documents j4cob/cabforum make

This will automatically download a Docker image containing the necessary dependencies, and run make in a container based off that image. The output will be available in the output/ directory. This docker command mounts the current directory as a volume, so it will build from the version of the documents in the current directory. You can edit files on the Docker host, and use Docker just for building.

If you want to install the dependencies without Docker, you'll need ruby, bundler, Python, pip, gcc, and several libraries installed. See Dockerfile for a list of packages installable on Debian. Make sure that ~/.local/bin/ is in your $PATH.

Install kramdown and weasyprint via bundler and pip, respectively:

bundle install
pip install --user -r requirements.txt

Then run make to build the documents:

make

The output is available in the output/ directory.

Building the Docker image locally

If you'd like to build a copy of the Docker image locally, for instance, to use a different version of Weasyprint or kramdown, run:

docker build --tag my_cabforum_tag .
docker run --rm --volume $PWD:/documents my_cabforum_tag make

documents's People

Contributors

awhalley avatar benwilsonusa avatar deanjc avatar gerv avatar jsha avatar konklone avatar kroeckx avatar pzb avatar sleevi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.