@openeo/processes-docgen
Advanced tools
Library to generate a user Interface for documents following the specification for openEO processes.
Library to generate a human-readable version of documents following the specification for openEO processes, either in version 0.4.x or 1.x.x.
You can simply create an HTML file and change the document and apiVersion (see below) prop to your needs:
<!DOCTYPE html>
<html>
<head>
<title>openEO Processes</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
<script src="https://cdn.jsdelivr.net/npm/@openeo/processes-docgen@1/dist/DocGen.umd.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@openeo/processes-docgen@1/dist/DocGen.css">
<style>html, body { height: 100%; margin: 0; }</style>
</head>
<body>
<div id="app"></div>
<script>
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,
}
})
});
</script>
<noscript>Sorry, the documentation generator requires JavaScript to be enabled!</noscript>
</body>
</html>
To build the files follow these steps:
vue.config.js and src/config.js to suit your needs.npm install on the command linenpm start.npm run build_standalone. Afterwards upload the content of the dist folder to your server.npm run build. Afterwards you can publish the library to npm or so.This project is licensed under the Apache 2.0 license - see the LICENSE file for details.
FAQs
Library to generate a user Interface for documents following the specification for openEO processes.
We found that @openeo/processes-docgen demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.