{"id":14979437,"url":"https://github.com/dita-ot/website","last_synced_at":"2025-08-21T20:32:57.217Z","repository":{"id":38985389,"uuid":"11386003","full_name":"dita-ot/website","owner":"dita-ot","description":"DITA Open Toolkit project website · dita-ot.org","archived":false,"fork":false,"pushed_at":"2024-10-06T20:02:27.000Z","size":33686,"stargazers_count":13,"open_issues_count":1,"forks_count":24,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-10-12T19:41:31.014Z","etag":null,"topics":["dita","dita-ot","documentation","documentation-tool","hacktoberfest","html","jekyll","jekyll-website","publishing"],"latest_commit_sha":null,"homepage":"https://www.dita-ot.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dita-ot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-07-13T09:35:58.000Z","updated_at":"2024-10-06T20:02:30.000Z","dependencies_parsed_at":"2024-05-04T20:39:17.528Z","dependency_job_id":"b0f29adc-dd63-46ac-89a9-bc16de4360ef","html_url":"https://github.com/dita-ot/website","commit_stats":{"total_commits":2055,"total_committers":21,"mean_commits":97.85714285714286,"dds":0.6666666666666667,"last_synced_commit":"95f09df2e40e8a3f07a5aee17a6411040160fd50"},"previous_names":[],"tags_count":67,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fwebsite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fwebsite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fwebsite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dita-ot%2Fwebsite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dita-ot","download_url":"https://codeload.github.com/dita-ot/website/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230532448,"owners_count":18240792,"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":["dita","dita-ot","documentation","documentation-tool","hacktoberfest","html","jekyll","jekyll-website","publishing"],"created_at":"2024-09-24T14:00:01.184Z","updated_at":"2024-12-20T04:07:54.086Z","avatar_url":"https://github.com/dita-ot.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DITA Open Toolkit website [![Netlify Status](https://api.netlify.com/api/v1/badges/0102588e-07a5-423b-8b26-aac92e14c168/deploy-status)](https://app.netlify.com/sites/dita-ot/deploys)\n\nThis repository contains the source files for the **DITA Open Toolkit** project website at [dita-ot.org][1].\n\nFor details and background information on how we build and maintain the site, visit [dita-ot.org/colophon][2].\n\n---\n\nIf you'd like to set up a local staging environment and build a copy of the site, follow the instructions below.\n\n\u003c!-- MarkdownTOC autolink=\"true\" bracket=\"round\" levels=\"2\" --\u003e\n\n- [Environment setup](#environment-setup)\n- [Install prerequisite software](#install-prerequisite-software)\n- [Running Jekyll](#running-jekyll)\n- [Building documentation output](#building-documentation-output)\n- [Updating JavaScript](#updating-javascript)\n- [Happy staging!](#happy-staging)\n\n\u003c!-- /MarkdownTOC --\u003e\n\n## Environment setup\n\n1.  Clone the DITA-OT and project website repositories:\n\n        git clone https://github.com/dita-ot/dita-ot.git\n        git clone https://github.com/dita-ot/website.git\n\n    **NOTE:** The examples below assume the the DITA-OT and project website repositories have been cloned to a common parent directory, such as your home folder. If you clone the repositories to a different location, substitute that path for the tilde symbol `~` in the samples below.\n\n2.  Move to the DITA-OT directory:\n\n        cd dita-ot\n\n3.  Fetch the submodules:\n\n        git submodule update --init --recursive\n\n4.  In the root directory, run the Gradle wrapper to compile the Java code and install plugins:\n\n        ./gradlew\n\n5.  Install the HTML plug-in for the DITA-OT project website: `org.dita-ot.html`\n\n        src/main/bin/dita --install https://github.com/dita-ot/org.dita-ot.html/archive/master.zip\n\n## Install prerequisite software\n\n1.  Check if [Ruby][3] is installed:\n\n        ruby -v\n\n    Ruby is installed on macOS and most Linux distributions by default. If the command above does not respond with information on the installed Ruby version, see [Installing Ruby][4] for instructions. _(Ruby 3.3 is required.)_\n\n2.  Install [Bundler][5]:\n\n        gem install bundler\n\n3.  Switch to your clone of the project website repository:\n\n        cd ~/dita-ot-website\n\n4.  Install all of the required gems from the project’s `Gemfile`:\n\n        bundle install\n\n## Running Jekyll\n\nTo build a copy of the site locally, use the `bundle` command to start the [Jekyll][6] build:\n\n    bundle exec jekyll serve\n\nThis runs the Jekyll build process and starts a local web server, so you can view your local clone of the project website at [127.0.0.1:4000][7].\n\nAt this stage, what you see there should be identical to the production version of the site at [www.dita-ot.org][1].\n\n**Note:** For more details, see [Setting up your GitHub Pages site locally with Jekyll][8].\n\nTo refresh the page in your browser whenever source files change, pass the `--livereload` option:\n\n    bundle exec jekyll serve --livereload\n\n### Running Jekyll from Docker\n\nJekyll can also be run from a Docker image. No additional dependencies need to be installed:\n\n```shell\ndocker run -it --rm -v $PWD:/website -e 4000 -p 4000:4000 ruby:$(head -1 .ruby-version) bash -c 'cd /website \u0026\u0026 bundle install \u0026\u0026 jekyll serve -H 0.0.0.0'\n```\n\nThis runs a local copy of the project website at [127.0.0.1:4000][7].\n\n## Building documentation output\n\n1.  Switch to the `docsrc` submodule of the local `dita-ot` clone:\n\n        cd ~/dita-ot/src/main/docsrc\n\n2.  Check out the `develop` branch of the `docs` repository to update the `docsrc` submodule pointer to the latest development state _(or to another branch if you need to generate output for that)_:\n\n        git checkout develop\n\n3.  Run the `site` build task with the Gradle wrapper to generate the output for the project website:\n\n        ./gradlew site\n\nThe output will be generated by default in `src/main/docsrc/build/site`.\n\n_(This appears as unstyled HTML when viewed in place.)_\n\nTo redirect the output to the `dev` development folder that Jekyll serves, pass the `outputDir` parameter to the build script as follows:\n\n    ./gradlew site -PoutputDir=~/dita-ot-website/dev\n\nAfter the build completes, you should find the results in the **Docs \\\u003e Development** section of the local staging environment [127.0.0.1:4000/dev/][9].\n\nTo automatically regenerate the site output whenever documentation source files change, add the `--continuous` build option:\n\n    ./gradlew site -PoutputDir=~/dita-ot-website/dev --continuous\n\n## Updating JavaScript\n\nIf you need to change any of the JavaScript files in the site repository, you'll need to [download \u0026 install Node.js][10] and run the `npm` package manager for JavaScript to perform a clean install of the project dependencies:\n\n    npm ci\n\nThis will install various Node modules including [Parcel][11], the web application bundler.\n\nTo make changes to the JavaScript code, add or edit source files in the `_js` folder. You can then run the `install` script to compile the modified JavaScript code to the (ignored) `js` folder with Parcel:\n\n    npm run install\n\n## Happy staging!\n\nYou can now use the local staging environment to test your changes before committing your work.\n\nWhen you're ready to share your progress, send us a [pull request][12].\n\n[1]: https://www.dita-ot.org\n[2]: https://www.dita-ot.org/colophon\n[3]: https://www.ruby-lang.org\n[4]: https://www.ruby-lang.org/en/documentation/installation\n[5]: https://bundler.io\n[6]: https://jekyllrb.com\n[7]: http://127.0.0.1:4000/\n[8]: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/\n[9]: http://127.0.0.1:4000/dev/\n[10]: https://nodejs.org/en/download/\n[11]: https://parceljs.org\n[12]: https://help.github.com/articles/about-pull-requests/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdita-ot%2Fwebsite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdita-ot%2Fwebsite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdita-ot%2Fwebsite/lists"}