{"id":20601016,"url":"https://github.com/smooll-d/ttt-docs","last_synced_at":"2026-06-04T17:31:37.644Z","repository":{"id":124730656,"uuid":"610955045","full_name":"smooll-d/TTT-docs","owner":"smooll-d","description":"Documentation for TTT.","archived":false,"fork":false,"pushed_at":"2023-03-09T19:02:34.000Z","size":484,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-16T09:07:47.905Z","etag":null,"topics":["cpp","docs","documentation","doxygen","doxygen-documentation","sfml","ttt","website"],"latest_commit_sha":null,"homepage":"https://reallysmooll.github.io/TTT-docs/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smooll-d.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2023-03-07T20:20:32.000Z","updated_at":"2023-03-07T20:31:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"b16b137c-a814-431e-850e-17caa9e977cb","html_url":"https://github.com/smooll-d/TTT-docs","commit_stats":null,"previous_names":["smooll-d/ttt-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smooll-d%2FTTT-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smooll-d%2FTTT-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smooll-d%2FTTT-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smooll-d%2FTTT-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smooll-d","download_url":"https://codeload.github.com/smooll-d/TTT-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234300371,"owners_count":18810607,"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":["cpp","docs","documentation","doxygen","doxygen-documentation","sfml","ttt","website"],"created_at":"2024-11-16T09:08:05.673Z","updated_at":"2025-01-17T01:46:00.217Z","avatar_url":"https://github.com/smooll-d.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# TTT-docs\nDocumentation for TTT.\n\n## Types of documentation\nThere are three types of documentation included in this repository:\n\n- HTML\n- LaTeX\n- man\n\n## Generating the documentation\n### Dependencies\nTo generate the documentation you will need these dependencies:\n\n- git\n- doxygen\n\nGenerating the documentation requires that you clone the TTT repository as well as the TTT-docs repository.\n\n**Why?**\n\nIt's because the TTT repo has the documentation and the Doxyfile needed to generate it and the TTT-docs repository is used to separate the library from the documentation and to not clutter the repository.\n\n### Cloning the repositories\nYou need to execute this commands:\n\n```bash\n$ git clone https://github.com/reallySmooll/TTT.git\n$ git clone https://github.com/reallySmooll/TTT-docs.git\n```\n\n### Actually generating the docs and moving them to the appropriate directories\nTo do that, you will need to execute this commands:\n\n```bash\n$ cd TTT/\n$ doxygen\n$ rm -rf ../TTT-docs/docs/\n$ mv docs/ ../TTT-docs/\n```\n\nAnd that's it! You now have basically offline TTT documentation.\n\n## Contributing\nThere are to ways in which you can contribute:\n\n- Making the site look prettier\n- Changing the documentation to add more information for example\n\n### Making the site look prettier\nThe TTT documentation uses a third party project called `Doxygen Awesome`, Which basically makes the site prettier automatically but it also has a ton of customization with which you can help.\n\nThe directory `docs/` contains a file called `custom.css` which is used to customize Doxygen Awesome. If you'd like to help, read up on the documentation of Doxygen Awesome and edit the `custom.css` file then commit the changes and make a pull request. I will review it and maybe you'll get your request pulled.\n\n### Changing the documentation\nThere's not much to it really. Go to any of the TTT library files and look for any comments starting with a `/**` or a `///\u003c`. These are comments that Doxygen uses to generate the documentation. Next, change them to add more information or change the information or remove some information, whatever. Commit your changes, make a pull request and wait.\n\n## Third party projects\n[Doxygen Awesome](https://www.github.com/jothepro/doxygen-awesome-css) - jothepro\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmooll-d%2Fttt-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmooll-d%2Fttt-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmooll-d%2Fttt-docs/lists"}