This repository contains the code for the OGC API - Records micro website. If you are impatient to get it running, just jump to the Quick Start section. If you want to reuse this code for another website, you can scroll down to the Reusing this repository section.
This website is intended to present and describe the OGC API - Records (at this stage, candidate) Standard to a wide audience of web developers. It is not meant as a replacement of the (candidate) Standard document, available here.
The website uses the node.js framework. The HTML is generated using the PUG template rendering engine.
Clone this repository with:
git clone https://github.com/opengeospatial/ogc-records-website.git
Then enter the folder:
cd ogc-records-website
Install dependencies:
npm install
Start development server:
npm start
Once you start the development server, the site will be available at:
http://localhost:3000
The hot reload will ensure that the changes you do on the code will be reflected on the browser.
When you are ready to commit changes, run:
npm run build
The scripts will generate a static build on ./dist
To deploy it to GitHub pages:
git subtree push --prefix dist origin gh-pages
You could fork and reuse the code on this repository for another Standard. This section contains some information to help you get started.
The content for the website is located on the pug files, under ./src/pug:
- index.pug: content and code for generating index.html
- blocks.pug: content and code for generating blocks.html
- patterns.pug: content and code for generating blocks.html
If you are not familiar with pug, you can read more about it here.
You should start by editing the header.masthead, which contains the title and tag line. Here is a summary of other sections to modify:
- what.page-section: high-level explanation of the Standard.
- why.page-section.: Highlight three main reasons to use the Standard (1-2 paragraphs max, each).
- how.page-section: description of how the Standard actually works. It should be longer than the
whatsection, but still not too long. For more details, point to other pages, like patterns. - inaction.page-section: live deployments of Standard implementations (ask for contributions, if needed).
- getstarted: list of implementations of the Standard, organised by servers and clients and programming language. This is normally taken from the implementations page on the GitHub repo of the Standard.
To edit the styles of the different sections, have a look at the ./src/scss/ folder. Global styles are on ./src/scss/_global.scss.
To update the backdrop image, place an image on ./src/assets/img and link it on _masthead.scss
This project is released under an MIT License
