Skip to content
This repository has been archived by the owner on Mar 18, 2024. It is now read-only.

complexdatacollective/documentation.networkcanvas.com

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Network Canvas Documentation

Local / development

Assumes http://localhost:4000 (default Jekyll dev port), for the basis of absolute URLs (for images and assets to be correctly references by PDF generation, set in _config-development.yml.

For development with live regeneration: jekyll serve

For development build: jekyll build

Default JEKYLL_ENV is JEKYLL_ENV=development. Not currently using this feature but you can insert it into templates if desired for conditional rendering:

{% if jekyll.environment == "production" %}
   {% include production-content %}
{% endif %}

Admin

The site is configured to publish directly to github.

You will need a github login to login to the admin section at https://documentaiton.networkcanvas.com/admin

Development

For local testing use the following configuration in admin/config.yml:

backend:
  name: git-gateway
local_backend: true

You'll also need to run: npx netlify-cms-proxy-server

Production

Assumes http://documentation.networkcanvas.com/ as site URL (set in _config-production.yml)

jekyll build JEKYLL_ENV=production --config _config.yml,_config-production.yml

Build PDF

  1. Build and deploy/serve site (needed for images)
  2. Depending on where assets are being hosted/served: (http://documentation.networkcanvas.com/) jekyll build JEKYLL_ENV=production --config _config.yml,_config-production.yml,_config-pdf.yml (http://localhost:4000) jekyll build JEKYLL_ENV=production --config _config.yml,_config-pdf.yml

Dependencies

We use PDFKit for generating PDFS, which relies on wkhtmltopdf as a dependency. Download the latest version from here.