Getting Started

This section is an overview of Abell Documentation and will help you navigate to the page you need.

Abell is a JavaScript based static-site-generator to help you build fast and secure websites from static data like JSON, Markdown, or CMS. Check out Why Abell section on our Home Page for more info.

Approaching Documentation

If you want to quickly get blog running, check out Creating Blog from Starter Themes

To learn Abell, you can approach this documentation in various ways


Requirements

Though it is not "required", if you're using VSCode, it is recommended to have Abell Language Features Extension for VSCode for syntax highlighting of .abell files.

Terms used in Documentation

  • Abell Components - Abell Components are the .abell files with content wrapped inside <AbellComponent> tag. Check out Abell Components Guide for more information. (Usually named as CamelCased.abell)
  • Abell Pages - Abell Pages are close to HTML, they have <html> tag and these files eventually become .html page in output. (Follow lowercase.abell format)
  • In documentation, you will find reference of npx command which comes along with the Node.js and NPM. It executes the scripts directly.

Plugins and Libraries

We got some plugins and libraries to make the job even easier!

Check out List of Plugins and Libraries of Abell →

Changelog

From v0.4.0, we'll be following Semantic-Versioning which means, now there will not be any breaking change until v1.0.0.

Check out Changelog of Abell.

Contributing

We are an open-source project and completely depend on open-source community for contribution, check out our Contributing to Abell Guide for more information on how to contribute.



GitHub Logo  Contribute to this page