KO
|
EN
gitlite — search
Search
#react
#python
#android
#javascript
#nodejs
#unity
#hacktoberfest
#linux
#visualization
#react-native
#csharp
#unity3d
helix-shared
★ 15
Open GitHub ↗
Shared libraries for Project Helix.
Download README (.md)
Explore Similar Repositories
helix-pipeline
:
request | markdown | html | response
helix-sidekick-extension
:
Browser extension for authors on AEM projects
helix-deploy
:
A multi-cloud deployment tool for serverless functions running on AWS Lambda, Adobe I/O Runtime, Azure Functions, and Google Cloud Functions. Write once, run everywhere.
helix-html-pipeline
:
A library for rendering the html response in Helix3.
helix-onedrive-cli
:
Command-line tools for onedrive integration
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
helix-shared
?
Download (.md)
# Helix Shared > Shared libraries for Project Helix. ## Status [](https://www.npmjs.com/package/@adobe/helix-shared) [](https://codecov.io/gh/adobe/helix-shared)  [](https://github.com/adobe/helix-shared/blob/main/LICENSE.txt) [](https://github.com/adobe/helix-shared/issues) [](https://snyk.io/test/github/adobe/helix-shared?targetFile=package.json) ## Helix Configuration Files - [`helix-fstab.yaml`](./docs/fstab.md): maps paths to source URLs, use this to pull content from sources other than GitHub - [`helix-config.yaml`](./docs/config.md): defines Strains (variants) of a Helix site, use this to create "environments", tests, or other variants - [`helix-query.yaml`](./docs/indexconfig.md): define what can be indexed and queried in a Helix site - [`helix-markup.yaml`](./docs/markup.md): define what Markdown should generate which HTML, use this to tweak the HTML output ## Usage * [API Documentation](docs/API.md) * [Configuration File Schema](docs/README.md) ### Using `HelixConfig` to read Helix configuration files Helix is using YAML files for configuration management, but with the `HelixConfig` class, exported from `@adobe/helix-shared`, you can read, validate, and access configuration files with ease: ```javascript const { HelixConfig } = require('@adobe/helix-shared'); // in an async function const configfromyaml = new HelixConfig() .withSource(yamlstring) .init(); const configfromjson = new HelixConfig() .withJSON(jsonobject) .init(); const configfromfile = new HelixConfig() .withDirectory('/path/to/dir') // the directory contains a `helix-config.yaml` .init(); ``` ### Using `sequence`, `functional`, and `op` for functional programming ## Development ### Build ```bash npm install ``` ### Test ```bash npm test ``` ### Lint ```bash npm run lint ```
