Code Monkey home page Code Monkey logo

gdc-docs's Introduction

GDC Open Source code

GDC is Open Source, Github Repositories containing source code of GDC Applications can be found on GDC GitHub Organization page.

Support

Please direct technical questions to GDC Support.

GDC Documentation Site

Technology

Install & Run

  • pip install -r requirements
  • mkdocs serve (optionally set port --dev-addr=0.0.0.0:<PORT>)

Build

  • mkdocs build --clean

Repository Conventions

  • All Shared content in the "Commons" directory
  • One Directory per GDC product (API, Data_Portal, Data_Submission_Portal, Data_Transfer_Tool)
  • Each GDC product have a Users_Guide and Release_Notes directory

Linking

To another documentation page

[Authentication and Authorization](../../Commons/Authentication.md)

Inside another documentation page

[Authentication and Authorization](../../Commons/Authentication.md#internal-section)

Adding icons and PDFs

The convention for this, when updating mkdocs.yml is the following:

  • <url ending in .pdf>: 'index.md' example:
  • fa-file-pdf-o Download PDF /API/PDF/API_UG.pdf: 'index.md'

Documentation Conventions

A detailed list of all conventions is available on GDC Website

Build PDF

Install mkdocs2pandoc, following instructions available here:

https://github.com/jgrassler/mkdocs-pandoc

Prepare a yml file dedicated to your Userguide, using Data_Portal_UG.yml as an example.

Run the following commands to:

  • Convert the User Guide to Pandoc:
  • Tweak the pandoc file
  • Build a PDF
mkdocs2pandoc -f Data_Portal_UG.yml -o docs/Data_Portal/PDF/Data_portal_UG.pd
sed -i -e 's/# / /g' docs/Data_Portal/PDF/Data_portal_UG.pd
sed -i -e 's/### /## /g' docs/Data_Portal/PDF/Data_portal_UG.pd
sed -i -e 's/\/site\//\/docs\//g' docs/Data_Portal/PDF/Data_portal_UG.pd
pandoc --toc -V documentclass=report -V geometry:"top=2cm, bottom=1.5cm, left=1cm, right=1cm" -f markdown+grid_tables+table_captions -o docs/Data_Portal/PDF/Data_portal_UG.pdf docs/Data_Portal/PDF/Data_portal_UG.pd

_

gdc-docs's People

Contributors

fgerthoffert avatar msfitzsimons avatar gaheens avatar purplepeopleeater avatar alex-wilmer avatar sergeymk avatar millerjs avatar phuongmy avatar cy avatar mikecules avatar hsahni avatar jacklightbody avatar

Watchers

James Cloos 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.