Nordcraft Documentation

This repository contains the official documentation for Nordcraft, a visual web development engine for building web applications.

Documentation Website

You can find the published documentation at: https://docs.nordcraft.com

Structure

The documentation is organized into numbered sections and pages, with each page in its own folder containing an index.md file and related assets:

docs/
  01-about-nordcraft/
    index.md
    image1.webp
    image1-large.webp
  02-use-cases/
    index.md
  ...
  18-guides/
    01-component-creation-guide/
      index.md
    99-contribution-guide/
      index.md

The numbering system determines the order in which sections and pages appear in the navigation.

Contributing

We welcome contributions from our community! If you'd like to contribute to the documentation, please read our Contribution Guide for details on our code of conduct, the process for submitting pull requests and an explanation of our documentation structure.

For quick fixes, you can click the "Edit" button on any documentation page, which will take you directly to the corresponding file in this repository.

Local Development

To preview the documentation locally:

1. Visit any page on the Nordcraft documentation site
2. Add ?mode=preview to the URL
3. Use the configuration panel at the bottom to set:
   • Repository owner
   • Repository name
   • Branch name
4. Click "Update" to see your changes

Feedback

If you find issues or have suggestions for the documentation:

1. Check existing issues to see if it's already been reported
2. Open a new issue describing the problem or suggestion in detail

License

The Nordcraft documentation is licensed under Apache License.