____ __ ____
/ __ \____ _____ ____/ /_ ____ / / /_
/ /_/ / __ `/ ___/ ___/ __ \/ __ \/ / __/
/ ____/ /_/ (__ |__ ) /_/ / /_/ / / /_
/_/ \__,_/____/____/_,___/\____/_/\__/
The open-source password management solution for teams
(c) 2019 Passbolt SA
https://www.passbolt.com
Passbolt help code is distributed under the Affero General Public License v3 Passbolt help text is distributed under Creative Common BY-SA-4.0
Logos in /assets/img/third_party belongs to their respective owners.
This repository contains the code used for the knowledge base and help section of passbolt website. Find out more about passbolt here: https://www.passbolt.com
This site is developed using Jekyll. To get started please read Jekyll quick start guide.
gem install jekyll bundler
git clone https://github.com/passbolt/passbolt_help.git
cd passbolt_help
bundle exec jekyll build
Jekyll offers all the tooling to make the local development easier.
bundle exec jekyll serve
Open the link given in the console with your web browser. Jekyll will rebuild the help site for you after each change.
Do not edit the style directly by editing the CSS on this repository. Passbolt help relies on passbolt styleguide. If you want to extend the styles make a pull request on the styleguide and apply the latest version of the styleguide to passbolt help. This is to ensure we provide a consistent user experience accross all the passbolt websites.
Since the styleguide is distributed as a npm module you can link your local passbolt help to your custom styleguide to test changes and extend the look and feel. See npm-link for more information.
Similarly if you want to add images to this site make sure you do not include them in assets folders that are
reserved by the styleguide such as /assets/img/screenshots or /assets/img/logo. Instead you can place them in /assets/img/help.