{"id":18938724,"url":"https://github.com/bilalm04/projectilesrs-mdbook","last_synced_at":"2026-03-22T07:30:18.749Z","repository":{"id":240113227,"uuid":"801588092","full_name":"BilalM04/projectileSRS-mdbook","owner":"BilalM04","description":"Manually ported SRS for the Projectile case study in Drasil","archived":false,"fork":false,"pushed_at":"2024-05-21T20:46:35.000Z","size":155,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-22T15:55:36.614Z","etag":null,"topics":["documentation","markdown","mdbook"],"latest_commit_sha":null,"homepage":"https://jacquescarette.github.io/Drasil/examples/projectile/SRS/srs/Projectile_SRS.html","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BilalM04.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-05-16T14:18:46.000Z","updated_at":"2024-05-27T22:25:57.139Z","dependencies_parsed_at":"2024-05-27T22:43:17.475Z","dependency_job_id":null,"html_url":"https://github.com/BilalM04/projectileSRS-mdbook","commit_stats":null,"previous_names":["bilalm04/projectilesrs-mdbook"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BilalM04%2FprojectileSRS-mdbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BilalM04%2FprojectileSRS-mdbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BilalM04%2FprojectileSRS-mdbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BilalM04%2FprojectileSRS-mdbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BilalM04","download_url":"https://codeload.github.com/BilalM04/projectileSRS-mdbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239937700,"owners_count":19721484,"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":["documentation","markdown","mdbook"],"created_at":"2024-11-08T12:15:18.012Z","updated_at":"2026-03-22T07:30:18.675Z","avatar_url":"https://github.com/BilalM04.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Software Requirements Specification (SRS) Demo using mdBook\n\nThis project represents a manually crafted Software Requirements Specification (SRS), utilizing mdBook, for the [Projectile](https://jacquescarette.github.io/Drasil/examples/projectile/SRS/srs/Projectile_SRS.html)\ncase study within the [Drasil](https://github.com/JacquesCarette/Drasil) framework. It is intended to serve as a foundational reference for future Drasil development, guiding the generation of a new SRS artifact format.\n\n## Installation\n\nPlease follow the installation instructions in the [mdBook Documentation](https://rust-lang.github.io/mdBook/guide/installation.html).\n\n## Demo\n\n1. **Clone the Repository**: Clone this repository to your local machine.\n2. **Launch the Server**: Open a command line interface in the cloned repository's directory and run `mdbook serve --open`.\n3. **Acces the Local Server**: The terminal will display the `localhost` server address.\n\n## mdBook Quirks\n\n- Have to wrap certain elements in `\u003cdiv id=\"\"\u003e\u003c/div\u003e` to be able to be referenced.\n  https://github.com/BilalM04/projectileSRS-mdbook/blob/f161644151831be02b66606552ba4b14f155e5c2/src/non-functional-req.md?plain=1#L4-L16\n- Cannot add captions to tables and images. Have to use `\u003cp align=\"center\"\u003eCAPTION\u003c/p\u003e`.\n  https://github.com/BilalM04/projectileSRS-mdbook/blob/f161644151831be02b66606552ba4b14f155e5c2/src/table-of-symbols.md?plain=1#L47-L49\n- Mathjax LaTeX equations do not wrap similar to LaTeX (`$EQUATION$`) or HTML (`\\(EQUATION\\)`). mdBook syntax is `\\\\(EQUATION\\\\)` for inline and `\\\\[EQUATION\\\\]` for block equations.\n- Some elements of equations require an extra `\\`. Ex. new line is `\\\\\\`.\n- `\\symbf` does not work in Mathjax LaTeX equations, have to use `\\boldsymbol` instead.\n- Typical list syntax does not work inside tables in Markdown. Have to wrap in `\u003cul\u003e \u003cli\u003eitem1\u003c/li\u003e \u003cli\u003eitem2\u003c/li\u003e \u003c/ul\u003e`.\n  https://github.com/BilalM04/projectileSRS-mdbook/blob/f161644151831be02b66606552ba4b14f155e5c2/src/data-definitions.md?plain=1#L13\n- Accessible assets (Ex. images) need to be inside the `src` folder in order to be rendered. NOTE: There may be a way to use assets outside `src` through the `book.toml`\n- Sometimes there is very little space or no space at all between components. Added `\u003c/br\u003e` to add extra space.\n- Need to add mathjax support in the `book.toml`. Not added by default.\n\n## Other Notes\n\n- Having a page for Table of Contents may be redundant as mdBook automatically creates one for you.\n- The HTML SRS for variables or short equations often uses HTML syntax, rather than LaTeX. For example, `\u003cem\u003e\u003c/em\u003e` for italicizing single variables. This creates slight differences in appearance within the SRS. The mdBook demo uses LaTeX for everything.\n- Each section and subsection has its own page. As a result, some pages have very little content.\n- Can format code for tables in two ways. Both formats look the same when rendered.\n  - Visually readable code but longer\n    https://github.com/BilalM04/projectileSRS-mdbook/blob/9cc1553a9c9f95de1735dcc81c5f3285f6c073f2/src/table-of-units.md?plain=1#L6-L12\n  - Less readable code but shorter\n    https://github.com/BilalM04/projectileSRS-mdbook/blob/9cc1553a9c9f95de1735dcc81c5f3285f6c073f2/src/auxiliary-constants.md?plain=1#L4-L10\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbilalm04%2Fprojectilesrs-mdbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbilalm04%2Fprojectilesrs-mdbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbilalm04%2Fprojectilesrs-mdbook/lists"}