{"id":14979513,"url":"https://github.com/pixeldroid/programming-pages","last_synced_at":"2025-10-28T18:31:48.381Z","repository":{"id":47440833,"uuid":"117453066","full_name":"pixeldroid/programming-pages","owner":"pixeldroid","description":"a jekyll theme for publishing code documentation to GitHub pages","archived":false,"fork":false,"pushed_at":"2020-02-22T23:00:12.000Z","size":3770,"stargazers_count":11,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-29T03:04:27.156Z","etag":null,"topics":["api-documentation-tool","docs","documentation","gh-pages","jekyll","jekyll-theme","markdown","publishing"],"latest_commit_sha":null,"homepage":"https://pixeldroid.github.io/programming-pages/","language":"CSS","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/pixeldroid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-14T17:52:52.000Z","updated_at":"2023-07-16T21:10:29.000Z","dependencies_parsed_at":"2022-08-20T16:50:24.080Z","dependency_job_id":null,"html_url":"https://github.com/pixeldroid/programming-pages","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Fprogramming-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Fprogramming-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Fprogramming-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pixeldroid%2Fprogramming-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pixeldroid","download_url":"https://codeload.github.com/pixeldroid/programming-pages/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219859014,"owners_count":16556038,"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":["api-documentation-tool","docs","documentation","gh-pages","jekyll","jekyll-theme","markdown","publishing"],"created_at":"2024-09-24T14:00:11.698Z","updated_at":"2025-10-28T18:31:47.934Z","avatar_url":"https://github.com/pixeldroid.png","language":"CSS","readme":"# programming-pages\n\na Jekyll theme for publishing code documentation to GitHub pages\n\n\u003e See **programming pages** used to document itself here: https://pixeldroid.github.io/programming-pages/\n\n[![screenshot][screenshot]][programming-pages-docs]\n\n\u003cbr/\u003e\n\n\n[installation](#installation) | [usage](#usage) | [building](#building) | [contributing](#contributing)\n\n\n## installation\n\n### as a remote theme\n\nSpecify `pixeldroid/programming-pages` as your remote theme in `_config.yml`:\n\n```yml\nplugins:\n  - jekyll-remote-theme\n\nremote_theme: pixeldroid/programming-pages\n```\n\n### as a gem\n\nFollow the Jekyll directions for [installing a gem-based theme][jekyll-theme]\n\n`Gemfile`:\n\n```ruby\ngem 'programming-pages'\n```\n\n`_config.yml`:\n\n```yml\ntheme: programming-pages\n```\n\n### as a local copy of the files\n\n1. Download the latest [release][releases]\n1. Extract it into your project under a folder of your choice (e.g. `docs/`)\n\n\n## usage\n\n\u003e first: \u003cbr\u003e\n\u003e 1. [Configure a publishing source for GitHub Pages][ghpages-howto] so GitHub knows where to find your documentation.\n\n1. [Author documentation][author-documentation]\n1. [Push to GitHub][push-to-github]\n1. Visit your documentation site at https://\u0026lt;`username`\u0026gt;.github.io/\u0026lt;`project`\u0026gt;\n1. _repeat_\n\n\u003cbr\u003e\n\n---\n\n\u003e If you just want to use the theme, you can stop reading here. \n\u003e The directions below are only useful if you're interested in building the theme from source. \u003cbr\u003e\n\n---\n\n\u003cbr\u003e\n\n## building\n\n**programming pages** depends on [Jekyll][jekyll], [Semantic UI][semantic], and [jQuery][jquery].\nThe dependencies are all captured and coordinated in the source of this project,\nbut if you want to update a dependency or change its configuration,\nyou'll need to be able to build them from source.\n\n### building the static site locally\n\n\u003e first: \u003cbr\u003e\n\u003e 1. [install jekyll][jekyll-install] and the [github-pages gem][ghpages-install]: `bundle install`\n\n```console\nrake docs\nopen http://localhost:4000/\n```\n\n### generating the semantic ui files\n\n\u003e first: \u003cbr\u003e\n\u003e 1. ensure you can [build semantic ui][semantic-build] (requires nodejs, npm, gulp): `gulp build`\n\u003e 1. check out the [programming-pages branch of the pixeldroid fork][semantic-custom] of semantic ui\n\n```console\nrake semantic['/path/to/programming-pages-semantic']\n```\n\n#### semantic ui modules\n\nThe Semantic UI modules required by this project are declared in `build/semantic/semantic.json`.\n\n### generating the jQuery file\n\n\u003e first \u003cbr\u003e\n\u003e 1. ensure you can [build jQuery][jquery-build] (requires nodejs, grunt): `grunt default`\n\n```console\ngrunt custom:-ajax,-wrap remove_map_comment\ncp /path/to/jquery/dist/jquery.min.js /path/to/programming-pages/_includes/scripts/jquery/jquery-\u003cversion\u003e.custom.min.js\n```\n\nDon't forget to update `assets/site.js` with the new filename.\n\n#### jQuery modules\n\n\u003e Smaller custom subsets of the jQuery library can be built by excluding unwanted modules.\n\u003e (see https://github.com/jquery/jquery#modules)\n\nThis project excludes the following unused modules to reduce file size:\n\n##### excluded\n- `ajax`\n- `wrap`\n\n##### required\n- `attr`\n- `classes`\n- `core`\n- `css`\n- `data`\n- `deferred` (required for `effects`)\n- `deprecated` (for jQuery Address's use of `bind`)\n- `dimensions`\n- `effects`\n- `events`\n- `filtering`\n- `init`\n- `manipulation`\n- `offsets`\n- `parseHTML`\n- `prop`\n- `ready`\n- `traversing`\n- `val`\n\n## contributing\n\n[Pull requests][pull-requests] for improved documentation, bug fixes and useful features are all welcome. :gift_heart:\n\n\n\n[author-documentation]: https://pixeldroid.github.io/programming-pages/guides/Authoring-Documentation/#/guides/ \"Authoring documentation using the programming pages site template\"\n[ghpages-howto]: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/ \"How to Configure a publishing source for GitHub Pages\"\n[ghpages-install]: https://github.com/github/pages-gem \"GitHub Pages Ruby Gem\"\n[jekyll]: https://jekyllrb.com/ \"Simple, blog-aware, static sites\"\n[jekyll-install]: https://jekyllrb.com/docs/installation/ \"How to install Jekyll\"\n[jekyll-theme]: https://jekyllrb.com/docs/themes/#installing-a-theme \"Installing a gem-based theme\"\n[jquery]: https://github.com/jquery/jquery#how-to-build-your-own-jquery \"jQuery is a fast, small, and feature-rich JavaScript library\"\n[jquery-build]: https://github.com/jquery/jquery#how-to-build-your-own-jquery \"How to build your own jQuery\"\n[programming-pages-docs]: https://pixeldroid.github.io/programming-pages/ \"a Jekyll theme for publishing code documentation to GitHub pages\"\n[pull-requests]: https://github.com/pixeldroid/programming-pages/pulls \"Pull requests for the Programming Pages template project\"\n[push-to-github]: https://help.github.com/articles/pushing-to-a-remote/ \"Pushing to a remote\"\n[releases]: https://github.com/pixeldroid/programming-pages/releases \"Packaged releases of the Programming Pages template\"\n[screenshot]: screenshot.png \"screenshot of a programming pages generated site\"\n[semantic]: https://semantic-ui.com/ \"Semantic is a UI component framework based around useful principles from natural language\"\n[semantic-build]: https://semantic-ui.com/introduction/build-tools.html \"Semantic UI build tools\"\n[semantic-custom]: https://github.com/pixeldroid/Semantic-UI/tree/programming-pages \"programming-pages branch of Semantic UI\"\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixeldroid%2Fprogramming-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpixeldroid%2Fprogramming-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpixeldroid%2Fprogramming-pages/lists"}