Oskari Map Application Framework aims to provide a framework and a collection of functionality-enhancing bundles and plugins for rapid development of feature-rich GI web applications.
Documentation available at [http://www.oskari.org].
All Oskari-related issues should be reported here: https://github.com/oskariorg/oskari-docs/issues
Please read the contribution guidelines before contributing pull requests to the Oskari project.
Copyright 2014 - present NLS under dual license MIT (included LICENSE.md) and EUPL v1.1 (any language version applies, English version is included in https://github.com/oskariorg/oskari-docs/blob/master/documents/LICENSE-EUPL.pdf).
// clone the repository
cd oskari-docs
npm install
node app
Additionally, if you want the .less
and .js
files to be compiled to and linked from /public
, run gulp
in the main directory.
Documentation and guides are in md
directory as markdown
documents. After creating a new document remember to reference it from either a page in views/documentation.jade
or views/guides.jade
(or another appropriate place) or from another document.
When added under md/documentation
or md/guides
the page is automatically routed to /documentation/<file location without the md extension>
or /guides/<file location without the md extension>
, respectively.
All the other content should be placed in the .jade
templates under views/
. Also, please see the routes.js
for details on how the content gets rendered.
- Update the "oskari-rpc" dependency version in package.json
- Run
npm update oskari-rpc
- Run
npm run build-rpc
This updates the public/js/rpc/rpc-client.min.js file
- Clone oskari-frontend git-repository next to oskari.org repository (at the same folder level)
- Checkout to specific tag/version on the Oskari repository you want to create docs for
- Run
VERSION=1.45.0 npm run docs
This generates files under generated/api/[version] folder.