{"id":20078627,"url":"https://github.com/strongbox/strongbox-docs","last_synced_at":"2025-03-02T13:14:37.420Z","repository":{"id":53488386,"uuid":"169924075","full_name":"strongbox/strongbox-docs","owner":"strongbox","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-30T01:06:31.000Z","size":7811,"stargazers_count":4,"open_issues_count":4,"forks_count":34,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-01-13T01:11:40.252Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://strongbox.github.io/","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/strongbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-09T23:16:39.000Z","updated_at":"2023-01-18T01:24:21.000Z","dependencies_parsed_at":"2025-01-13T01:21:01.458Z","dependency_job_id":null,"html_url":"https://github.com/strongbox/strongbox-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongbox%2Fstrongbox-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongbox%2Fstrongbox-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongbox%2Fstrongbox-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongbox%2Fstrongbox-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/strongbox","download_url":"https://codeload.github.com/strongbox/strongbox-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241509658,"owners_count":19974071,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-11-13T15:15:53.549Z","updated_at":"2025-03-02T13:14:37.400Z","avatar_url":"https://github.com/strongbox.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pre-requisites\n\n* Docker\n\n**OR**\n\n* python3\n* pip\n* mkdocs-material (it should install mkdocs automatically)\n* mkdocs-markdownextradata-plugin \n* mkdocs-git-revision-date-plugin\n\n# Getting Started\n\nIf you prefer to go with locally installed `python` and `pip`, then:\n\n1. `pip install -r requirements.txt`\n2. `mkdocs serve` (binds to `http://localhost:8000`)\n\nIf you prefer going the `docker-compose` way:\n\n1. `docker-compose up` (binds to `http://localhost:8000`)\n\nIf you prefer plain `docker`:\n\n`docker run -it --rm -v ./:/docs -p 8000:8000 strongboxci/mkdocs:base mkdocs serve`\n\n# Building \n\nExecute one of these (depending on your local setup):\n\n1. `mkdocs build`\n2. `docker run -it --rm -v ./:/docs -p 8000:8000 strongboxci/mkdocs:base mkdocs build`\n\n# Live Pre-view:\n\nRun the following and then browse to `localhost:8000`:\n```\ndocker-compose up\n```\n\n# Guidelines For Contributors\n\n* When adding new pages it is preferable to have the filename with lowercase characters.\n* The first line of the page should be `# Page Title` - this helps in the indexing and search afterwards.\n* Avoid using `h1` (i.e `# my header`) at places other than the page title. Having multiple `h1` \n  confuses the `Table of contents` section so please avoid that as well.\n* If you are adding a `resource` like `PDF`, `image`, `XML` file, it should be placed under `./docs/assets/resources/`.\n* Use `{{resource}}/path/to/asset` when linking to the resource. You can also use `{{url}}` and ``{{assets}}`` depending\n  on which link you need.\n* An exception is when linking to internal docs. Just use relative URLs to the markdown file. Mkdocs will take care to build the links. Follow [this guide][mkdocs internal-links].\n* Please avoid using `inline links` and use `reference links` instead as it makes maintenance easier.  \n  Avoid this example:  \n  ```\n  [I'm an inline-style link pointing to Strongbox](https://github.com/strongbox/strongbox) and here is some text in addition so that I can then add again the same link [I'm an inline-style link pointing to Strongbox](https://github.com/strongbox/strongbox)\n  ```\n  Prefered example:\n  ```\n  [I'm a reference link to Strongbox] and here is some text in addition so that I can then add again the same link [I'm a reference link to Strongbox], we can have this link repeating forever in the document and easily change it by just changing it from where reference is. ([I'm a reference link to Strongbox] just for fun.)  \n  // insert somewhere at the bottom of the page \n  [I'm a reference link to Strongbox]: https://github.com/strongbox/strongbox\n  ```\n\n\n# Pull Requests\n\nShortly after you open a pull request, a hook will trigger live preview deployiment to netlify.com. You will be able to check your PR live at the link `deploy/netlify` provides in github's PR checks section.\n\n# Structure\n\nWe have divided the documentation into 3 sections:\n\n1. `User guide` - pages with instructions for how to use Strongbox as a normal \"user\".\n2. `Developer guide` - pages with instructions for developers who are interested in contributing.\n3. `Knowledge base` - pages which explain some of our concepts as well as other important information.\n\n[mkdocs internal-links]: https://www.mkdocs.org/user-guide/writing-your-docs/#internal-links\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrongbox%2Fstrongbox-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstrongbox%2Fstrongbox-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrongbox%2Fstrongbox-docs/lists"}