{"id":13591672,"url":"https://github.com/thi-ng/org-spec","last_synced_at":"2025-04-09T21:18:43.192Z","repository":{"id":41432413,"uuid":"64547882","full_name":"thi-ng/org-spec","owner":"thi-ng","description":"Org-mode skeleton for technical specifications \u0026 HTML theme","archived":false,"fork":false,"pushed_at":"2018-08-30T15:03:23.000Z","size":27,"stargazers_count":301,"open_issues_count":15,"forks_count":44,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-09T21:18:38.802Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://demo.thi.ng/org-spec/","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/thi-ng.png","metadata":{"files":{"readme":"README.org","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}},"created_at":"2016-07-30T14:26:16.000Z","updated_at":"2025-03-27T21:55:59.000Z","dependencies_parsed_at":"2022-09-21T08:52:27.006Z","dependency_job_id":null,"html_url":"https://github.com/thi-ng/org-spec","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thi-ng%2Forg-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thi-ng%2Forg-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thi-ng%2Forg-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thi-ng%2Forg-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thi-ng","download_url":"https://codeload.github.com/thi-ng/org-spec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111973,"owners_count":21049578,"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":"2024-08-01T16:01:00.472Z","updated_at":"2025-04-09T21:18:43.170Z","avatar_url":"https://github.com/thi-ng.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"#+TITLE: thi.ng/org-spec\n\nAn [[http://orgmode.org][Org-mode]] template for technical specification documents and HTML\npublishing\n\n* Features\n\n- Specification document skeleton for a web application, incl. usage\n  examples of various org-mode features:\n  - Inline, text-based diagramming via [[http://ditaa.sourceforge.net][Ditaa]], [[http://graphviz.org][Graphviz]] \u0026 [[http://plantuml.com/][PlantUML]]\n  - Hyperlink abbreviations (incl. presets for GitHub, RFC, W3C, Wikipedia)\n  - Section status flags, tags \u0026 custom properties\n  - Tables\n  - Named section IDs for internal x-refs\n  - Footnotes\n  - Automatically updating fields (e.g. publication date)\n  - Automatic updating of document changelog (using git commits)\n- Beautiful, minimal, responsive CSS theme with print support (also\n  for PDF generation)\n- Basic syntax highlighting of code blocks\n\n* Example output\n\nTake a look at the published version of the included demo document:\n\nhttp://demo.thi.ng/org-spec/\n\nThe corrensponding =.org= source file:\nhttps://raw.githubusercontent.com/thi-ng/org-spec/master/index.org\n\n* Getting started\n\nThe =index.org= source file contains everything (apart from CSS, which\nis located in the =/css= dir), including build instructions and\nfurther comments, not visible in the exported document.\n\nYou can use =s3cmd= to quickly publish the generated HTML version to\nAWS S3, like so:\n\n#+BEGIN_SRC shell\n  # if you need to install s3cmd first\n  brew install s3cmd\n  s3cmd --configure\n\n  # optionally create a website bucket\n  s3cmd ws-create s3://BUCKETNAME\n\n  # only upload HTML, CSS \u0026 PNGs\n  s3cmd -P --recursive --exclude=* \\\n        --include=index.html \\\n        --include=*.css \\\n        --include=assets/*.png \\\n        put . s3://BUCKETNAME\n#+END_SRC\n\n* Diagramming \u0026 exporting\n\nThe template heavily utilizes Org-mode's =noweb= references to\nassemble diagrams from individual snippets, as well as to provide\nCSS-like functionality for diagrams by defining a single snippet (per\ndiagram tool) containing global styles.\n\n- http://orgmode.org/manual/Noweb-reference-syntax.html#Noweb-reference-syntax\n- http://orgmode.org/manual/noweb_002dref.html#noweb_002dref\n- http://orgmode.org/manual/noweb.html#noweb\n\nThe code blocks actually defining the full diagrams are all located in\nthe last section of the document (titled \"Diagram definitions\"). This\nsection is only present in the source code and will NOT be exported to\nHTML (however the code blocks are still evaluated during export and\nhence produce the diagrams each time).\n\nIf your doc contains a lot of such diagrams (especially PlantUML),\nthen exporting can take quite a long while. To save time (and if\nyou're not currently working on diagram parts), you can temporarily\ndisable the evaluation of ALL code blocks by setting the\n=org-export-babel-evaluate= to =nil=:\n\n#+BEGIN_SRC emacs-lisp\n  (setq org-export-babel-evaluate nil)\n\n  ;; to re-enable...\n  (setq org-export-babel-evaluate t)\n#+END_SRC\n\n* Custom property export\n\nBy default the template is configured to export only a specific set of\nproperties stored in drawers attached to a section/sub-tree. The list\nof exported property names can be edited in line 4 of the template:\n\n#+BEGIN_SRC org\n#+OPTIONS: prop:(\"VERSION\")\n#+END_SRC\n\nTo enable all properties:\n\n#+BEGIN_SRC org\n#+OPTIONS: prop:t\n#+END_SRC\n\n* License\n\nMIT License, (c) 2016 Karsten Schmidt\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthi-ng%2Forg-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthi-ng%2Forg-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthi-ng%2Forg-spec/lists"}