{"id":21330762,"url":"https://github.com/olomadev/olodoc-bootstrap","last_synced_at":"2025-09-15T09:17:21.044Z","repository":{"id":262114343,"uuid":"886255390","full_name":"olomadev/olodoc-bootstrap","owner":"olomadev","description":"Bootstrap + Vite template launcher to create custom css templates.","archived":false,"fork":false,"pushed_at":"2024-12-31T18:46:28.000Z","size":258,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"1.x","last_synced_at":"2025-08-12T16:43:05.879Z","etag":null,"topics":["boostrap5","documentation-generator","documentation-tool","template"],"latest_commit_sha":null,"homepage":"https://olodoc.oloma.dev","language":"JavaScript","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/olomadev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"eguvenc","patreon":"olobase"}},"created_at":"2024-11-10T15:48:17.000Z","updated_at":"2024-12-31T18:49:02.000Z","dependencies_parsed_at":"2025-01-01T00:17:28.093Z","dependency_job_id":null,"html_url":"https://github.com/olomadev/olodoc-bootstrap","commit_stats":null,"previous_names":["olomadev/olodoc-bootstrap"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/olomadev/olodoc-bootstrap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olomadev%2Folodoc-bootstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olomadev%2Folodoc-bootstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olomadev%2Folodoc-bootstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olomadev%2Folodoc-bootstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/olomadev","download_url":"https://codeload.github.com/olomadev/olodoc-bootstrap/tar.gz/refs/heads/1.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olomadev%2Folodoc-bootstrap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275233900,"owners_count":25428502,"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","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["boostrap5","documentation-generator","documentation-tool","template"],"created_at":"2024-11-21T22:24:30.074Z","updated_at":"2025-09-15T09:17:21.010Z","avatar_url":"https://github.com/olomadev.png","language":"JavaScript","funding_links":["https://github.com/sponsors/eguvenc","https://patreon.com/olobase"],"categories":[],"sub_categories":[],"readme":"\n# Olodoc Bootstrap Template Generator\n\nOlodoc is written with \u003ca href=\"https://getbootstrap.com/docs/5.3/getting-started/introduction/\" target=\"_blank\"\u003eBoostrap 5\u003c/a\u003e css framework and supports extensive customizations. Before creating a new documentation project, you may want to customize the colors or components of your project. Customization operations can be easily done with the \u003ca href=\"https://github.com/olomadev/olodoc-bootstrap\" target=\"_blank\"\u003eOlodoc Boostrap + Vite Skelethon\u003c/a\u003e template generation tool, follow the steps below.\n\nEnter your project root.\n\n```sh\ncd /var/www/olodoc-bootstrap\n```\n\nInstall node modules.\n\n```sh\nnpm i\n```\n\nRun the application\n\n```sh\nnpm run dev\n```\n\nVisit your local address from your browser.\n\n![Localhost](/src/images/localhost.png)\n\n## Customize Your Template\n\nThe template generator allows you to create your documentation using the colors and fonts you want by changing the values of the \u003cb\u003e.scss\u003c/b\u003e variables.\n\n```sh\n- olodoc-bootstrap\n  + node_modules\n  - src\n  \t- css\n  \t\t_variables.scss\n  \t\tfonts.scss\n  \t\tolodoc.css\n  \t\tprism.css\n  \t\tstyles.scss\n  \t+ dist\n  \t+ images\n  \t+ js\n  + views\n  .gitignore\n  package.json\n  server.js\n  vite.config.js\n```\n\nOpen your \u003cb\u003e\\_variables.scss\u003c/b\u003e file and change the \u003cb\u003e$primary:  #0a7248;\u003c/b\u003e variable's value as \u003cb\u003e#f75b00\u003c/b\u003e.\n\n```scss [line-numbers] data-line=\"5\"\n//\n// All Boostrap Variables: \n// Here --\u003e  https://github.com/twbs/bootstrap/blob/main/scss/_variables.scss\n//\n$primary: #f75b00; //  #0a7248;\n$secondary: #636363;\n$success: #42ba96;\n$info: #7c69ef;\n$warning: #fad776;\n$danger: #df4759;\n// ...\n```\n\nRun the application again\n\n```sh\nnpm run dev\n```\n\n![Localhost](/src/images/localhost.png)\n\nVisit your local address from your browser, if everything went well you will see that the template main colors have changed as below.\n\n![Boostrap Sass Customization](/src/images/bootstrap-sass-customization.png)\n\n## Exporting Production Ready Css Files\n\n1. Go to your command line type build command.\n\n```sh\nnpm run build\n```\n\nif everything went well you will see the built message like below.\n\n```sh\n✓ 92 modules transformed.\ndist/index.html                  14.69 kB │ gzip:  4.21 kB\ndist/assets/index-BJBYL9CF.css  313.94 kB │ gzip: 41.29 kB\ndist/assets/index-C1TT0zOb.js   121.41 kB │ gzip: 25.79 kB\n✓ built in 4.17s\nroot@localhost:/var/www/olodoc-bootstrap# \n```\n\n2. Copy your generated \u003cb\u003eindex-\\**.css\u003c/b\u003e and \u003cb\u003eindex-\\**.js\u003c/b\u003e files.\n\n```sh\n- olodoc-bootstrap\n  - dist\n  \t- assets\n  \t\tindex-BJBYL9CF.css\n  \t\tindex-C1TT0zOb.js\n  \tindex.html\n  + node_modules\n  + views\n  .gitignore\n  package.json\n  server.js\n  vite.config.js\n```\n\n3. Then paste them into your php project \u003ckbd\u003e/public/assets/\u003c/kbd\u003e directory.\n\n```sh\n- olodoc-skeleton\n  + bin\n  + config\n  + data\n  - public\n  \t- assets\n  \t\t+ css\n  \t\t+ img\n  \t\t+ js\n  \t\tindex-BJBYL9CF.css\n  \t\tindex-C1TT0zOb.js\n\t  + images\n\t  .htaccess\n\t  index.php\n\t  robots.txt\n\t  sitemap.xml\n  + src\n  + templates\n  + vendor\n  .gitignore\n  composer.json\n```\n\n4. Finally you need update new filenames which they located in \u003ckbd\u003e/templates/layouts/default.phtml\u003c/kbd\u003e file.\n\n```html [line-numbers] data-line=\"11,12\"\n\u003c!DOCTYPE html\u003e\n\u003chtml lang=\"\u003c?php echo LANG_ID?\u003e\"\u003e\n\u003chead\u003e\n  \u003c?php echo $this-\u003eheadTitle().PHP_EOL; ?\u003e\n  \u003cmeta charset=\"utf-8\" /\u003e\n  \u003cmeta name=\"author\" content=\"Oloma Software\"\u003e\n  \u003c?php echo $this-\u003eheadMeta().PHP_EOL; ?\u003e\n  \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\" /\u003e\n  \u003c?php echo $this-\u003eheadLink().PHP_EOL; ?\u003e\n  \u003clink rel=\"preconnect\" href=\"https://fonts.gstatic.com\" crossorigin\u003e\n  \u003cscript type=\"module\" crossorigin src=\"/assets/index-C1TT0zOb.js\"\u003e\u003c/script\u003e\n  \u003clink rel=\"stylesheet\" crossorigin href=\"/assets/index.BJBYL9CF.css\"\u003e\n  \u003c!-- Favicon --\u003e\n  \u003clink rel=\"apple-touch-icon\" sizes=\"120x120\" href=\"/assets/favicon/apple-touch-icon.png\"\u003e\n```\n\nVisit your php application from your browser.\n\n![Skeleton Php Application Localhost](/src/images/example-local.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folomadev%2Folodoc-bootstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folomadev%2Folodoc-bootstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folomadev%2Folodoc-bootstrap/lists"}