Content for
JavaScript Shell Java HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
src fix link to screenshot Aug 10, 2018
verify Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
.editorconfig Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
.eslintdefaults Initial repo config Jul 29, 2016
.eslintrc Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
.gitattributes
.gitignore
.npmrc Package-lock: Removed for content repo Dec 29, 2017
.prettierignore
.prettierrc Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
404.html Hot-reload - no-clean option added Jul 11, 2017
README.md
build.js Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
config.yml Config: added alternative versions Feb 5, 2018
dev-server.js Updated Builder and allowed for nx_assets + linting enhancements Aug 2, 2018
nodemon.json Build: Working using doc-builder module Aug 2, 2016
package.json Remove npm dependency Aug 10, 2018
update-frontmatter.js

README.md

Documentation Content

Development

Requirements

See the main project requirements as well as the authoring requirements.

Installation

Clone the repository to your local machine (and remember where it's saved :)), using your favorite git client or the command line:

git lfs clone https://github.com/nuxeo/doc.nuxeo.com-content
cd doc.nuxeo.com-content
git lfs install
git reset --hard

Run Locally

npm run dev

Refer to the authoring instrutions for further details. Hint: append /nxdoc or /userdoc to the URL.

Change browser

To change the from the default browser.

Project Structure

./assets/...

Any files in this directory will be copied to ./site/assets and can be referenced in html and templates.

./build.js

The main build script for generating the output for site.

./config.yml

Site configurations, ability to have production or development specific values.

./site/...

Generated output of the site. This is what will be served in production.

./src/...

Source Markdown and HTML files for content. Read the page about writing documentation, markdown and handlebars

./verify/...

Verification tests specific to this repository post build.

Trouble shooting

See main project trouble shooting.