Subscribe
Subscribe

FAQ

Welcome to the SourceJS FAQ page! Here, we’ve compiled answers to some of the most commonly asked questions about our platform. If you can’t find the answer you’re looking for, feel free to contact us for further assistance.

1. What is SourceJS?

SourceJS is a powerful tool for documenting, testing, and managing UI components. It allows developers to create interactive style guides and maintain comprehensive documentation directly alongside their code, improving collaboration and efficiency in frontend development.

2. How do I install SourceJS?

To install SourceJS, follow these steps:

  1. Ensure you have Node.js installed on your machine.
  2. Install SourceJS globally using npm:bashКопировать кодnpm install -g sourcejs
  3. Initialize a new SourceJS project:bashКопировать кодsourcejs init
  4. Start the SourceJS server:bashКопировать кодsourcejs start
  5. Access your style guide at http://localhost:8080.

3. How do I configure SourceJS?

SourceJS configuration is managed through the sourcejs/config.js file in your project directory. You can modify settings such as:

  • Port number
  • Enabled plugins
  • Paths and layouts

4. How do I create and document components?

To create and document components:

  1. Navigate to the components directory in your project.
  2. Create a folder for your component.
  3. Add your component’s HTML, Haml, or other markup files to this folder.
  4. Include a README.md file in the component’s folder for documentation.

5. What plugins are available for SourceJS?

SourceJS supports a variety of plugins to extend its functionality. You can find a list of available plugins and their descriptions in our Plugin Marketplace. To install a plugin, follow the installation instructions provided for each plugin.

6. How do I integrate SourceJS with other technologies?

SourceJS can be integrated with various technologies such as HTML, Haml, NodeJS, and more. For specific integration instructions, refer to our Integration Guide.

7. How do I update SourceJS?

To update SourceJS to the latest version, use the following command:

npm update -g sourcejs

Check our Changelog for details on the latest updates and changes.

8. What should I do if I encounter an error?

If you encounter an error:

  1. Check the Troubleshooting Guide for common issues and solutions.
  2. Review the error message for specific details.
  3. If the problem persists, contact our support team at [email protected] with details about the issue.

9. What is the SourceJS license?

SourceJS is available under the MIT License. This means you can use, modify, and distribute SourceJS freely, as long as you include the original copyright notice and license in any distributed copies or substantial portions of the software.

10. How can I contribute to SourceJS?

We welcome contributions from the community! To contribute:

  1. Fork our GitHub repository.
  2. Make your changes and test them.
  3. Submit a pull request with a description of your changes.

11. How do I get support?

For support, you can:

  • Visit our Help Center for documentation and troubleshooting.
  • Contact us directly at [email protected].
  • Join discussions and ask questions in our Community Forum.