{"id":23879369,"url":"https://github.com/ceedubs/indoctrinate","last_synced_at":"2025-06-21T12:39:26.037Z","repository":{"id":28002647,"uuid":"31496964","full_name":"ceedubs/indoctrinate","owner":"ceedubs","description":"A sample scala project demonstrating a good setup for documentation","archived":false,"fork":false,"pushed_at":"2015-03-01T13:16:02.000Z","size":398,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-22T23:26:48.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://stew.github.io/indoctrinate/","language":"Scala","has_issues":false,"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/ceedubs.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}},"created_at":"2015-03-01T13:15:18.000Z","updated_at":"2017-10-11T07:40:23.000Z","dependencies_parsed_at":"2022-08-03T04:45:25.764Z","dependency_job_id":null,"html_url":"https://github.com/ceedubs/indoctrinate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ceedubs/indoctrinate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceedubs%2Findoctrinate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceedubs%2Findoctrinate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceedubs%2Findoctrinate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceedubs%2Findoctrinate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceedubs","download_url":"https://codeload.github.com/ceedubs/indoctrinate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceedubs%2Findoctrinate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261126206,"owners_count":23113290,"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":[],"created_at":"2025-01-03T22:51:59.786Z","updated_at":"2025-06-21T12:39:21.021Z","avatar_url":"https://github.com/ceedubs.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\nThis repository has a single subproject named docs, it has all the\nmachinery of the [cats](https://github.com/non/cats) project, but\nstripped of all content except for a few demo files that you can\nimmediately start playing with.\n\nTo get started playing right away, clone this repository, then start\nreading\n[here](https://github.com/stew/indoctrinate/blob/master/docs/src/site/index.md)\nor read the [generated documentation site](http://stew.github.io/indoctrinate/)\n\nIf you want to incorporate this into your project, you can perhaps\ncopy the docs directory from this project into your own project and\ndefine docs to be a subproject of your build, then start editing the\nfiles inside docs/src to customize your site.\n\nWe are relying on 4 different sbt plugins for documentation:\n\n## [tut](https://github.com/tpolecat/tut)\n\nTut gives us the ability to \"compile\" our documentation against code\nin the other sub-projects.  Code in \"tut sheds\" like this:\n\n    ```tut\n    println(\"hello world\")\n    List(1,2,3).sum\n    ```\n\nTut compiles all the documentation, replacing the tut sheds with\nscala sheds that shows running the original context in a repl\nsession:\n \n    ```scala\n    scala\u003e println(\"hello world\")\n    hello world\n\n    scala\u003e List(1,2,3).sum\n    res1: Int = 6\n    ```\n\nTut uses `.md` files in `docs/src/main/tut` as its source, and outputs\ncompiled .md files to `docs/target/site/tut`\n\n## [sbt-unidoc](https://github.com/sbt/sbt-unidoc)\n\nThis is useful when your project has multiple sub-projects and you\nwant to generate one scaladoc site covering all of them.\n\n## [sbt-site](https://github.com/sbt/sbt-site)\n\nsbt-site takes the contents of a static directory, the output of tut,\nand the output of scaladoc, and populates `docs/target/site`\n\nyou generate the site by running `sbt docs/makeSite`\n\n## [sbt-ghpages](https://github.com/sbt/sbt-ghpages)\n\nAfter you have tested your pages and you are ready to push them to\ngithub you run `sbt docs/ghpagesPushSite` to push this generated site\nto a remote repo in a `gh-pages` branch. To control which repository\nit is pushing to, you must edit the build variable in `docs/build.sbt`: \n\n    git.remoteRepo := \"git@github.com:notyours/pony.git\"\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceedubs%2Findoctrinate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceedubs%2Findoctrinate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceedubs%2Findoctrinate/lists"}