31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
# Visual Editing Frontend Library by Directus
|
||
|
||
This library works together with a Directus instance to enable Visual Editing functionality from within the Visual
|
||
Editor module in Directus Studio.
|
||
|
||
Web developers must make use of this library to ensure communication between their website’s HTML elements and their
|
||
Directus instance. This is done through data attributes and helper functions built into the library and imported into
|
||
your website.
|
||
|
||
## Documentation
|
||
|
||
Documentation covering the setup and functionality for both the frontend library and the studio module can be found in
|
||
the [Directus documentation](https://directus.io/docs/guides/content/visual-editor).
|
||
|
||
## Test Website
|
||
|
||
A test website pre-configured to work with the Directus Visual Editor module is included in the library’s repository.
|
||
This can be used for example purposes and to make it easy to set up an environment for testing or contributing.
|
||
|
||
For detailed instructions on setting up the test environment see the
|
||
[test website's readme.md](https://github.com/directus/visual-editing/blob/main/test-website/readme.md).
|
||
|
||
## License
|
||
|
||
This package is licensed under the MIT License. See the LICENSE file for more information.
|
||
|
||
## Additional Resources
|
||
|
||
- [Directus Website](https://directus.io)
|
||
- [Directus GitHub Repository](https://github.com/directus/directus)
|