https://github.com/open-eo/openeo-processes-docgen
Library to generate a user interface for documents following the specification for openEO processes.
https://github.com/open-eo/openeo-processes-docgen
Last synced: about 1 year ago
JSON representation
Library to generate a user interface for documents following the specification for openEO processes.
- Host: GitHub
- URL: https://github.com/open-eo/openeo-processes-docgen
- Owner: Open-EO
- License: apache-2.0
- Created: 2018-07-13T14:00:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-29T16:46:14.000Z (almost 4 years ago)
- Last Synced: 2024-04-25T05:22:24.656Z (about 2 years ago)
- Language: Vue
- Homepage: https://open-eo.github.io/openeo-processes-docgen/demo/
- Size: 7.99 MB
- Stars: 2
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openEO Processes DocGen
Library to generate a human-readable version of documents following the [specification for openEO processes](https://github.com/open-eo/openeo-api), either in version 0.4.x or 1.x.x.
* [Demo](https://open-eo.github.io/openeo-processes-docgen/demo/).
## Getting Started
You can simply create an HTML file and change the `document` and `apiVersion` (see below) prop to your needs:
```
openEO Processes
html, body { height: 100%; margin: 0; }
new Vue({
el: '#app',
render: h => h(DocGen, {
props: {
// Either (1) a URL to the document as string
// or (2) an array or object containing the processes.
document: 'processes.json',
// The version of the openEO API
apiVersion: "1.2.0",
// Title for the table of contents
// title: "My processes",
// Sorts the processes by id if set to true, otherwise keeps order of the document
// sortProcessesById: true,
// Categorize the processes in the menu if set to true, otherwise show a plain list
// categorize: true,
// Show/Hide table of contents, links and search box
// showTableOfContents: true,
// A message that is shown to users
// notice: ''
// Show or hide experimental and/or deprecated entites by default (e.g. processes, collections)
// showExperimentalByDefault: false,
// showDeprecatedByDefault: false,
}
})
});
Sorry, the documentation generator requires JavaScript to be enabled!
```
## Development
To build the files follow these steps:
1. Install [Node.js](https://nodejs.org/)
2. Clone or download this repository.
3. Open a command line window and go to the directory which contains the cloned/downloaded web editor files.
4. Optionally: Configure the generator by editing `vue.config.js` and `src/config.js` to suit your needs.
5. Install the dependencies by executing `npm install` on the command line
6.
* Development: Run the development server by executing `npm start`.
* Deployment:
* Standalone: Build the project by executing `npm run build_standalone`. Afterwards upload the content of the `dist` folder to your server.
* Library: Build the project by executing `npm run build`. Afterwards you can publish the library to npm or so.
## License
This project is licensed under the Apache 2.0 license - see the [LICENSE](LICENSE) file for details.