The WYcreative Engineering Team project documentation app.
It is intended to be used with Genesis.
npm install @wycreative/atlas
import generateAtlas from '@wycreative/atlas';
import pkg from './package.json' assert {type: 'json'};
import atlas from './config/atlas.js';
import config from './config/index.js';
generateAtlas({
package: pkg,
atlas,
paths: {
destination: getDirectory(config.build.atlas),
buildBase: config.build.base,
symbols: config.src.symbols,
symbolsRoot: getDirectory(config.build.images),
examples: config.examples.base,
views: config.examples.views,
},
});
Generates an Atlas instance.
Type: Object
The package.json
contents.
Type Object
The Genesis's config/atlas/*.js(on)
export objects with Atlas configurations in a single object.
Type Object
The list of path configurations.
Type String
The Atlas build destination path.
Type String
The build base path.
Type String | Array
The path/glob or list of paths/globs of the source SVG symbols.
Type String
The path where the built SVG symbols are.
Type String
The examples source base path.
Type String[]
The list of paths/globs of the examples source view files.
The first one will be extracted, its glob parent taken, and each object type appended to it with a glob for nested Pug files.
With the repository cloned locally, open the terminal pointed to the repository's root and run:
npm install
Then, to start the project, run:
npm start
Command | Description |
---|---|
npm start |
Builds the project, starts the local server, and watches for changes. |
npm run serve |
Starts the local server and watches for changes. |
npm test |
Checks for code-style issues. |
npm run dist |
Prepares de built code for distribution. |
npm run clean |
Deletes the compiled code in build and dist directories. |
npm run prepublishOnly |
Runs the whole build and distribution process. This is intended to be used internally by npm when releasing a new package version. |
npm run release |
Runs the release workflow, including validating the codebase, running a clean build and distribution process, and releasing a new package version. |