Skip to content

OpenBibleProject/website

Repository files navigation

OpenBibleProject 📖

Read this in: Deutsch 🇺🇸

The OpenBibleProject provides a specification for bible modules that are both easy to implement and portable.

All the modules are licensed under permissive licenses, so that you don't have to worry about licensing when using them in your projects.

Available modules

Contributing

... to the bible modules

If you would like to contribute to the bible modules, make yourself familiar with the module spec.

The first step would be to convert your translation into individual markdown files for each book / chapter, then you can add the index file for metadata.

If your module is done, upload it to Github and submit the link and licensing information about the translation via the Github Discussion feature.

... to the documentation

The OpenBibleProject website & documentation is built using Astro and the Starlight theme.

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

If you'd like to translate pages, create a file with the same name in the respective language subdirectory.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

OpenBibleProject, an awesomeBible project.

awesomeBible Logo

Releases

No releases published

Packages

No packages published