diff options
| author | fr33domlover <fr33domlover@riseup.net> | 2019-07-30 11:43:14 +0300 |
|---|---|---|
| committer | fr33domlover <fr33domlover@riseup.net> | 2019-07-30 11:43:14 +0300 |
| commit | e54dd94dfb9a5dd4f58d4f3ea4313f7b9e1709f4 (patch) | |
| tree | 618f3ce52bc8abce021a3ddad27cf3defe4d177f | |
| parent | 88755cac76e2a801aa44a8e53918f9b146ee9fac (diff) | |
Add dark theme by ikomi :)
26 files changed, 620 insertions, 172 deletions
@@ -1,5 +1,7 @@ #!/bin/bash +set -e + inputs="forgefed forgefed-vocabulary" git_branch=`git rev-parse --abbrev-ref HEAD` @@ -14,21 +16,28 @@ dirty () { git diff-index --quiet HEAD -- } -render () { - dir="$1" - file="$2" +runPandoc () { + local dir="$1" + local file="$2" if [ "$3" == "true" ]; then - toc="--table-of-contents" + local toc="--table-of-contents" else - toc="" + local toc="" fi - dirty - if [ $? -eq 0 ]; then - gitdirty="" + local theme="$4" + + if [ "$theme" == "light" ]; then + local otherTheme="/index/dark" + local otherThemeName="π" + local output="html/$file.html" + local suffix=".html" else - gitdirty="--variable gitdirty" + local otherTheme="/index" + local otherThemeName="π" + local output="html/$file/dark.html" + local suffix="/dark.html" fi pandoc $dir/$file.md \ @@ -36,15 +45,34 @@ render () { --to html \ --template html/template.html \ $toc \ - $gitdirty \ --variable "gitbranch:$git_branch" \ --variable "gitcommitid:$git_commit_id" \ --variable "gitcommitidshort:$git_commit_id_short" \ --variable "date:$now" \ + --variable "theme:$theme" \ + --variable "other-theme:$otherTheme" \ + --variable "other-theme-name:$otherThemeName" \ + --variable "suffix:$suffix" \ --number-sections \ - --output html/$file.html + --output "$output" + #$gitdirty \ } +render () { + local dir="$1" + local file="$2" + local toc="$3" + runPandoc $dir $file $toc "light" + runPandoc $dir $file $toc "dark" +} + +#dirty +#if [ $? -eq 0 ]; then +# gitdirty="" +#else +# gitdirty="--variable gitdirty" +#fi + render html index "false" for file in $inputs; do diff --git a/html/dark.css b/html/dark.css new file mode 100644 index 0000000..87a5cf2 --- /dev/null +++ b/html/dark.css @@ -0,0 +1,267 @@ +/* Font links ------------------------------------------------------------- */
+@font-face {
+ font-family:"Open Sans";
+ font-weight: 400;
+ font-style: normal;
+ src: local("Open Sans Regular"),
+ url("/fonts/open-sans/open-sans-regular.woff2") format("woff2"),
+ url("/fonts/open-sans/open-sans-regular.woff") format("woff");
+}
+@font-face {
+ font-family:"Open Sans";
+ font-weight: 400;
+ font-style: italic;
+ src: local("Open Sans Italic"),
+ url("/fonts/open-sans/open-sans-italic.woff2") format("woff2"),
+ url("/fonts/open-sans/open-sans-italic.woff") format("woff");
+}
+@font-face {
+ font-family:"Open Sans";
+ font-weight: 600;
+ font-style: normal;
+ src: local("Open Sans Bold"),
+ url("/fonts/open-sans/open-sans-bold.woff2") format("woff2"),
+ url("/fonts/open-sans/open-sans-bold.woff") format("woff");
+}
+@font-face {
+ font-family:"Open Sans";
+ font-weight: 600;
+ font-style: italic;
+ src: local("Open Sans Bold Italic"),
+ url("/fonts/open-sans/open-sans-bold-italic.woff2") format("woff2"),
+ url("/fonts/open-sans/open-sans-bold-italic.woff") format("woff");
+}
+
+@font-face {
+ font-family:"Hack";
+ font-weight: 400;
+ font-style: normal;
+ src: local("Hack Regular"),
+ url("/fonts/hack/hack-regular.woff2") format("woff2"),
+ url("/fonts/hack/hack-regular.woff") format("woff");
+}
+
+
+/* General ---------------------------------------------------------------- */
+:root {
+ /* Palette */
+ --orange: #ff851b;
+ --light-orange: #ed9c55;
+ --gray: #808080;
+ --light-gray: #c8c8c8;
+ --dark-gray: #33334a;
+
+ /* Syntax highlighting palette */
+ --red: #c60901;
+ --slate-gray: #555;
+ --shadow-gray: #26263d;
+
+ /* Font declarations */
+ --sans-font: Open Sans, Noto Sans, Helvetica, sans-serif;
+ --mono-font: Hack, Noto Mono, Courier, monospace;
+
+ /* Effect transitions */
+ --link-trans: color 0.5s, background 0.5s, ease-in-out;
+ --img-trans: opacity 0.5s ease-in-out;
+}
+
+* {
+ margin: 0;
+ padding: 0;
+ box-sizing: border-box;
+}
+
+html {
+ background: var(--dark-gray);
+ color: #fff;
+ font-family: var(--sans-font);
+ font-size: 62.5%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: var(--orange);
+ word-wrap: break-word;
+}
+h1 {
+ margin: 4rem 0 2rem;
+ font-size: 2.8rem;
+}
+h2 {
+ margin: 3rem 0 1.5rem;
+ font-size: 2.4rem;
+}
+h3 {
+ margin: 3rem 0 1.5rem;
+ font-size: 2.2rem;
+}
+
+a {
+ color: var(--light-gray);
+ text-decoration: none;
+}
+ a:hover {
+ background: var(--light-gray);
+ color: var(--dark-gray);
+ border-radius: 0.2rem;
+ transition: var(--link-trans);
+ }
+ a:visited { color: var(--gray); }
+
+code {
+ font-family: var(--mono-font);
+}
+
+
+/* Sections --------------------------------------------------------------- */
+
+.header {
+ margin: 5rem auto;
+}
+
+ .header-title {
+ text-align: center;
+ margin: 0 auto 1.6rem;
+ font-size: 3.8rem;
+ }
+ .header-title__link, .header-title__link:hover {
+ background: none;
+ color: var(--orange);
+ text-decoration: none;
+ }
+
+
+.nav {
+ margin: 0 auto;
+}
+ .nav__link {
+ font-size: 2rem;
+ color: var(--light-gray);
+ text-decoration: none;
+ }
+
+
+.main {
+ font-size: 1.6rem;
+ word-wrap: break-word;
+}
+
+ .main-title {
+ font-size: 2.6rem;
+ }
+
+ .main p { margin: 1.5rem 0; }
+
+ .main ul { list-style: none; }
+ .main ul li:before {
+ content: "β’";
+ padding: 0 0.5rem 0 0;
+ }
+
+.toc {
+ margin: 2rem 0 4rem;
+ background: var(--shadow-gray);
+ border-radius: 0.5rem;
+}
+
+ .toc-title {
+ margin: 0 0 1rem;
+ color: var(--orange);
+ font-size: 2rem;
+ }
+
+ .toc ul { list-style: none; }
+ .toc ul li:before { content: unset; }
+ .toc ul li ul li { margin: 0 0 0 1.2rem; }
+ .toc ul li ul li ul li { margin: 0 0 0 2.6rem; }
+
+
+.footer {
+ margin: 4rem auto;
+ font-size: 1.2rem;
+}
+
+ .footer p {
+ margin: 1rem 0;
+ text-align: center;
+ }
+
+ .footer a[rel="license"]:hover {
+ background: none;
+ }
+ .footer a[rel="license"] img {
+ margin: 1rem auto;
+ border: 0;
+ opacity: 0.8;
+ }
+ .footer a[rel="license"] img:hover {
+ opacity: 1.0;
+ transition: var(--img-trans);
+ }
+
+
+/* Syntax highlighting ---------------------------------------------------- */
+
+div.sourceCode {
+ padding: 0 1rem;
+ border-top: 1.2rem solid var(--light-orange);
+ border-radius: 0.5rem;
+ background: var(--shadow-gray);
+}
+pre.sourceCode {
+ padding: 2rem 0;
+ background: var(--shadow-gray);
+ overflow: auto;
+}
+.sourceLine, .sourceLine:hover {
+ background: var(--shadow-gray);
+ color: var(--slate-gray);
+}
+.sourceLine .er { color: var(--red); } /* Error */
+.sourceLine .dt { color: var(--gray); } /* Datatype */
+.sourceLine .st { color: var(--light-orange); } /* String */
+
+
+/* Media queries ---------------------------------------------------------- */
+
+@media (max-width: 689px) {
+ .header, .main, .footer { padding: 0 2rem; }
+
+ /* Stack nav items */
+ .nav { width: 18rem; }
+ .nav__link { display: block; }
+
+ /* TOC spans full width */
+ .toc {
+ margin: 0 -2rem;
+ padding: 4rem 2rem;
+ }
+}
+
+
+@media (min-width: 690px) {
+ .header, .main, .footer { padding: 0 5rem; }
+
+ /* Horizontal nav */
+ .nav { text-align: center; }
+ .nav__link {
+ margin: 0 1rem;
+ display: inline;
+ }
+
+ /* TOC is 45% of min-width */
+ .toc {
+ margin: 0;
+ padding: 4rem;
+ width: 31rem;
+ }
+}
+
+
+@media (min-width: 960px) {
+ /* Center sections, set fixed width */
+ .header, .main, .footer {
+ width: 95rem;
+ margin-left: auto;
+ margin-right: auto;
+ }
+}
diff --git a/html/fonts/cabin/cabin-bold-italic.woff b/html/fonts/cabin/cabin-bold-italic.woff Binary files differdeleted file mode 100644 index d5c0d4e..0000000 --- a/html/fonts/cabin/cabin-bold-italic.woff +++ /dev/null diff --git a/html/fonts/cabin/cabin-bold-italic.woff2 b/html/fonts/cabin/cabin-bold-italic.woff2 Binary files differdeleted file mode 100644 index d25d5d9..0000000 --- a/html/fonts/cabin/cabin-bold-italic.woff2 +++ /dev/null diff --git a/html/fonts/cabin/cabin-bold.woff b/html/fonts/cabin/cabin-bold.woff Binary files differdeleted file mode 100644 index ce1f277..0000000 --- a/html/fonts/cabin/cabin-bold.woff +++ /dev/null diff --git a/html/fonts/cabin/cabin-bold.woff2 b/html/fonts/cabin/cabin-bold.woff2 Binary files differdeleted file mode 100644 index cb8e967..0000000 --- a/html/fonts/cabin/cabin-bold.woff2 +++ /dev/null diff --git a/html/fonts/cabin/cabin-italic.woff b/html/fonts/cabin/cabin-italic.woff Binary files differdeleted file mode 100644 index 52cf2a2..0000000 --- a/html/fonts/cabin/cabin-italic.woff +++ /dev/null diff --git a/html/fonts/cabin/cabin-italic.woff2 b/html/fonts/cabin/cabin-italic.woff2 Binary files differdeleted file mode 100644 index ca44ee8..0000000 --- a/html/fonts/cabin/cabin-italic.woff2 +++ /dev/null diff --git a/html/fonts/cabin/cabin-regular.woff b/html/fonts/cabin/cabin-regular.woff Binary files differdeleted file mode 100644 index c575666..0000000 --- a/html/fonts/cabin/cabin-regular.woff +++ /dev/null diff --git a/html/fonts/cabin/cabin-regular.woff2 b/html/fonts/cabin/cabin-regular.woff2 Binary files differdeleted file mode 100644 index 5b6c54c..0000000 --- a/html/fonts/cabin/cabin-regular.woff2 +++ /dev/null diff --git a/html/fonts/cabin/ofl.txt b/html/fonts/cabin/ofl.txt deleted file mode 100644 index d7f477e..0000000 --- a/html/fonts/cabin/ofl.txt +++ /dev/null @@ -1,91 +0,0 @@ -This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded,
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting -- in part or in whole -- any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/html/fonts/open-sans/license.txt b/html/fonts/open-sans/license.txt new file mode 100644 index 0000000..75b5248 --- /dev/null +++ b/html/fonts/open-sans/license.txt @@ -0,0 +1,202 @@ +
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/html/fonts/open-sans/open-sans-bold-italic.woff b/html/fonts/open-sans/open-sans-bold-italic.woff Binary files differnew file mode 100644 index 0000000..ab5da69 --- /dev/null +++ b/html/fonts/open-sans/open-sans-bold-italic.woff diff --git a/html/fonts/open-sans/open-sans-bold-italic.woff2 b/html/fonts/open-sans/open-sans-bold-italic.woff2 Binary files differnew file mode 100644 index 0000000..4c16c73 --- /dev/null +++ b/html/fonts/open-sans/open-sans-bold-italic.woff2 diff --git a/html/fonts/open-sans/open-sans-bold.woff b/html/fonts/open-sans/open-sans-bold.woff Binary files differnew file mode 100644 index 0000000..fa3101f --- /dev/null +++ b/html/fonts/open-sans/open-sans-bold.woff diff --git a/html/fonts/open-sans/open-sans-bold.woff2 b/html/fonts/open-sans/open-sans-bold.woff2 Binary files differnew file mode 100644 index 0000000..b96780d --- /dev/null +++ b/html/fonts/open-sans/open-sans-bold.woff2 diff --git a/html/fonts/open-sans/open-sans-italic.woff b/html/fonts/open-sans/open-sans-italic.woff Binary files differnew file mode 100644 index 0000000..80a40da --- /dev/null +++ b/html/fonts/open-sans/open-sans-italic.woff diff --git a/html/fonts/open-sans/open-sans-italic.woff2 b/html/fonts/open-sans/open-sans-italic.woff2 Binary files differnew file mode 100644 index 0000000..08adf49 --- /dev/null +++ b/html/fonts/open-sans/open-sans-italic.woff2 diff --git a/html/fonts/open-sans/open-sans-regular.woff b/html/fonts/open-sans/open-sans-regular.woff Binary files differnew file mode 100644 index 0000000..a7f9ed2 --- /dev/null +++ b/html/fonts/open-sans/open-sans-regular.woff diff --git a/html/fonts/open-sans/open-sans-regular.woff2 b/html/fonts/open-sans/open-sans-regular.woff2 Binary files differnew file mode 100644 index 0000000..4b56d9d --- /dev/null +++ b/html/fonts/open-sans/open-sans-regular.woff2 diff --git a/html/forgefed-vocabulary.html b/html/forgefed-vocabulary.html index 5231c84..e476d0a 100644 --- a/html/forgefed-vocabulary.html +++ b/html/forgefed-vocabulary.html @@ -4,7 +4,7 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>ForgeFed Vocabulary</title> - <link rel="stylesheet" type="text/css" href="light.css" /> + <link rel="stylesheet" type="text/css" href="/light.css" /> </head> <body class="body"> <header class="header"> @@ -13,22 +13,23 @@ </h1> <nav class="nav"> <a class="nav__link" - href="forgefed.html">π² behavior</a> + href="/forgefed.html">π² behavior</a> <a class="nav__link" - href="forgefed-vocabulary.html">π vocabulary</a> + href="/forgefed-vocabulary.html">π vocabulary</a> <a class="nav__link" href="https://notabug.org/peers/forgefed/issues">π issues</a> <a class="nav__link" href="https://talk.feneas.org/c/forgefed">πͺ forum</a> + <a class="nav__link" + href="/index/dark.html">π</a> </nav> </header> <main class="main"> <h1 class="main-title"> - ForgeFed Vocabulary - draft - 2019-07-24 master - <a href="https://notabug.org/peers/forgefed/commit/0c9efdedf6b8f959c5d303b288493c43cb2ea52a"> - 0c9efde + ForgeFed Vocabulary - draft - 2019-07-30 master + <a href="https://notabug.org/peers/forgefed/commit/88755cac76e2a801aa44a8e53918f9b146ee9fac"> + 88755ca </a> - [dirty] </h1> <nav class="toc"> @@ -56,10 +57,13 @@ <li><a href="#dependedby"><span class="toc-section-number">4.4</span> dependedBy</a></li> <li><a href="#dependencies"><span class="toc-section-number">4.5</span> dependencies</a></li> <li><a href="#dependants"><span class="toc-section-number">4.6</span> dependants</a></li> - <li><a href="#committedby"><span class="toc-section-number">4.7</span> committedBy</a></li> - <li><a href="#filesadded"><span class="toc-section-number">4.8</span> filesAdded</a></li> - <li><a href="#filesmodified"><span class="toc-section-number">4.9</span> filesModified</a></li> - <li><a href="#filesremoved"><span class="toc-section-number">4.10</span> filesRemoved</a></li> + <li><a href="#repository-1"><span class="toc-section-number">4.7</span> repository</a></li> + <li><a href="#committedby"><span class="toc-section-number">4.8</span> committedBy</a></li> + <li><a href="#hash"><span class="toc-section-number">4.9</span> hash</a></li> + <li><a href="#committed"><span class="toc-section-number">4.10</span> committed</a></li> + <li><a href="#filesadded"><span class="toc-section-number">4.11</span> filesAdded</a></li> + <li><a href="#filesmodified"><span class="toc-section-number">4.12</span> filesModified</a></li> + <li><a href="#filesremoved"><span class="toc-section-number">4.13</span> filesRemoved</a></li> </ul></li> </ul> </nav> @@ -139,11 +143,20 @@ <a class="sourceLine" id="cb4-3" title="3"> <span class="st">"https://www.w3.org/ns/activitystreams"</span><span class="ot">,</span></a> <a class="sourceLine" id="cb4-4" title="4"> <span class="st">"https://forgefed.peers.community/ns"</span></a> <a class="sourceLine" id="cb4-5" title="5"> <span class="ot">]</span><span class="fu">,</span></a> - <a class="sourceLine" id="cb4-6" title="6"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span></a> - <a class="sourceLine" id="cb4-7" title="7"> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo/commit/2c7323781aec1f7"</span><span class="fu">,</span></a> - <a class="sourceLine" id="cb4-8" title="8"> <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span></a> - <a class="sourceLine" id="cb4-9" title="9"> <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"Add an installation script, fixes issue #89"</span></a> - <a class="sourceLine" id="cb4-10" title="10"><span class="fu">}</span></a></code></pre></div> + <a class="sourceLine" id="cb4-6" title="6"> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo/commits/109ec9a09c7df7fec775d2ba0b9d466e5643ec8c"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-7" title="7"> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"Commit"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-8" title="8"> <span class="dt">"repository"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice/myrepo"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-9" title="9"> <span class="dt">"attributedTo"</span><span class="fu">:</span> <span class="st">"https://example.dev/bob"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-10" title="10"> <span class="dt">"committedBy"</span><span class="fu">:</span> <span class="st">"https://example.dev/alice"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-11" title="11"> <span class="dt">"hash"</span><span class="fu">:</span> <span class="st">"109ec9a09c7df7fec775d2ba0b9d466e5643ec8c"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-12" title="12"> <span class="dt">"name"</span><span class="fu">:</span> <span class="st">"Add an installation script, fixes issue #89"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-13" title="13"> <span class="dt">"description"</span><span class="fu">:</span> <span class="fu">{</span></a> + <a class="sourceLine" id="cb4-14" title="14"> <span class="dt">"mediaType"</span><span class="fu">:</span> <span class="st">"text/plain"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-15" title="15"> <span class="dt">"content"</span><span class="fu">:</span> <span class="st">"It's about time people can install on their computers!"</span></a> + <a class="sourceLine" id="cb4-16" title="16"> <span class="fu">},</span></a> + <a class="sourceLine" id="cb4-17" title="17"> <span class="dt">"created"</span><span class="fu">:</span> <span class="st">"2019-07-11T12:34:56Z"</span><span class="fu">,</span></a> + <a class="sourceLine" id="cb4-18" title="18"> <span class="dt">"committed"</span><span class="fu">:</span> <span class="st">"2019-07-26T23:45:01Z"</span></a> + <a class="sourceLine" id="cb4-19" title="19"><span class="fu">}</span></a></code></pre></div> <h3 id="ticketdependency"><span class="header-section-number">3.3.2</span> TicketDependency</h3> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#TicketDependency</code></p> <p><strong>Notes:</strong> Represents a relationship between 2 tickets, in which the resolution of one ticket requires the other ticket to be resolved too. It MUST specify the subject, object and relationship properties, and the relationship property MUST be βdependsOnβ.</p> @@ -235,7 +248,15 @@ <p><strong>Functional:</strong> Yes</p> <p><strong>Inverse of:</strong> (None)</p> <p><strong>Example:</strong></p> - <h2 id="committedby"><span class="header-section-number">4.7</span> committedBy</h2> + <h2 id="repository-1"><span class="header-section-number">4.7</span> repository</h2> + <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#repository</code></p> + <p><strong>Notes:</strong> Identifies the repository to which a commit belongs.</p> + <p><strong>Domain:</strong> <code>Commit</code></p> + <p><strong>Range:</strong> <code>Repository</code></p> + <p><strong>Functional:</strong> Yes</p> + <p><strong>Inverse of:</strong> (None)</p> + <p><strong>Example:</strong></p> + <h2 id="committedby"><span class="header-section-number">4.8</span> committedBy</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#committedBy</code></p> <p><strong>Notes:</strong> Identifies the actor (usually a person, but could be something else, e.g.Β a bot) that added a set of changes to the version-control repository. Sometimes the author of the changes and the committer of those changes arenβt the same actor, in which case the <code>committedBy</code> property can be used to specify who added the changes to the repository. For example, when applying a patch to a repository, e.g.Β a Git repository, the author would be the person who made the patch, and the committer would be the person who applied the patch to their copy of the repository.</p> <p><strong>Domain:</strong> <code>Commit</code></p> @@ -243,7 +264,23 @@ <p><strong>Functional:</strong> Yes</p> <p><strong>Inverse of:</strong> (None)</p> <p><strong>Example:</strong></p> - <h2 id="filesadded"><span class="header-section-number">4.8</span> filesAdded</h2> + <h2 id="hash"><span class="header-section-number">4.9</span> hash</h2> + <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#hash</code></p> + <p><strong>Notes:</strong> Specifies the hash associated with a commit, which is a unique identifier of the commit within the repository, usually generated as a cryptographic hash function of some (or all) of the commitβs data or metadata. For example, in Git it would be the SHA1 hash of the commit; in Darcs it would be the SHA1 hash of the patch info.</p> + <p><strong>Domain:</strong> <code>Commit</code></p> + <p><strong>Range:</strong> <code>xsd:string</code> of hexadecimal digit ASCII characters</p> + <p><strong>Functional:</strong> Yes</p> + <p><strong>Inverse of:</strong> (None)</p> + <p><strong>Example:</strong></p> + <h2 id="committed"><span class="header-section-number">4.10</span> committed</h2> + <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#committed</code></p> + <p><strong>Notes:</strong> Specifies the time that a set of changes was committed into the repository and became a commit in it. This can be different from the time the set of changes was produced, e.g.Β if one person creates a patch and sends to another, and the other person then applies the patch to their copy of the repository. We call the former event βcreatedβ and the latter event βcommittedβ, and this latter event is specified by the <code>committed</code> property.</p> + <p><strong>Domain:</strong> <code>Commit</code></p> + <p><strong>Range:</strong> <code>xsd:dateTime</code></p> + <p><strong>Functional:</strong> Yes</p> + <p><strong>Inverse of:</strong> (None)</p> + <p><strong>Example:</strong></p> + <h2 id="filesadded"><span class="header-section-number">4.11</span> filesAdded</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#filesAdded</code></p> <p><strong>Notes:</strong> Specifies a filename, as a relative path, relative to the top of the tree of files in the repository, of a file that got added in this commit, and didnβt exist in the previous version of the tree.</p> <p><strong>Domain:</strong> <code>Commit</code></p> @@ -251,7 +288,7 @@ <p><strong>Functional:</strong> No</p> <p><strong>Inverse of:</strong> (None)</p> <p><strong>Example:</strong></p> - <h2 id="filesmodified"><span class="header-section-number">4.9</span> filesModified</h2> + <h2 id="filesmodified"><span class="header-section-number">4.12</span> filesModified</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#filesModified</code></p> <p><strong>Notes:</strong> Specifies a filename, as a relative path, relative to the top of the tree of files in the repository, of a file that existed in the previous version of the tree, and its contents got modified in this commit.</p> <p><strong>Domain:</strong> <code>Commit</code></p> @@ -259,7 +296,7 @@ <p><strong>Functional:</strong> No</p> <p><strong>Inverse of:</strong> (None)</p> <p><strong>Example:</strong></p> - <h2 id="filesremoved"><span class="header-section-number">4.10</span> filesRemoved</h2> + <h2 id="filesremoved"><span class="header-section-number">4.13</span> filesRemoved</h2> <p><strong>URI:</strong> <code>https://forgefed.peers.community/ns#filesRemoved</code></p> <p><strong>Notes:</strong> Specifies a filename, as a relative path, relative to the top of the tree of files in the repository, of a file that existed in the previous version of the tree, and got removed from the tree in this commit.</p> <p><strong>Domain:</strong> <code>Commit</code></p> diff --git a/html/forgefed.html b/html/forgefed.html index 9de420e..e5e6f6b 100644 --- a/html/forgefed.html +++ b/html/forgefed.html @@ -4,7 +4,7 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>ForgeFed</title> - <link rel="stylesheet" type="text/css" href="light.css" /> + <link rel="stylesheet" type="text/css" href="/light.css" /> </head> <body class="body"> <header class="header"> @@ -13,22 +13,23 @@ </h1> <nav class="nav"> <a class="nav__link" - href="forgefed.html">π² behavior</a> + href="/forgefed.html">π² behavior</a> <a class="nav__link" - href="forgefed-vocabulary.html">π vocabulary</a> + href="/forgefed-vocabulary.html">π vocabulary</a> <a class="nav__link" href="https://notabug.org/peers/forgefed/issues">π issues</a> <a class="nav__link" href="https://talk.feneas.org/c/forgefed">πͺ forum</a> + <a class="nav__link" + href="/index/dark.html">π</a> </nav> </header> <main class="main"> <h1 class="main-title"> - ForgeFed - draft - 2019-07-24 master - <a href="https://notabug.org/peers/forgefed/commit/0c9efdedf6b8f959c5d303b288493c43cb2ea52a"> - 0c9efde + ForgeFed - draft - 2019-07-30 master + <a href="https://notabug.org/peers/forgefed/commit/88755cac76e2a801aa44a8e53918f9b146ee9fac"> + 88755ca </a> - [dirty] </h1> <nav class="toc"> diff --git a/html/index.html b/html/index.html index c18925c..928ad81 100644 --- a/html/index.html +++ b/html/index.html @@ -4,7 +4,7 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>ForgeFed</title> - <link rel="stylesheet" type="text/css" href="light.css" /> + <link rel="stylesheet" type="text/css" href="/light.css" /> </head> <body class="body"> <header class="header"> @@ -13,13 +13,15 @@ </h1> <nav class="nav"> <a class="nav__link" - href="forgefed.html">π² behavior</a> + href="/forgefed.html">π² behavior</a> <a class="nav__link" - href="forgefed-vocabulary.html">π vocabulary</a> + href="/forgefed-vocabulary.html">π vocabulary</a> <a class="nav__link" href="https://notabug.org/peers/forgefed/issues">π issues</a> <a class="nav__link" href="https://talk.feneas.org/c/forgefed">πͺ forum</a> + <a class="nav__link" + href="/index/dark.html">π</a> </nav> </header> <main class="main"> diff --git a/html/template.html b/html/template.html index e7eb1f0..0aac8a2 100644 --- a/html/template.html +++ b/html/template.html @@ -4,7 +4,7 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>$title$</title> - <link rel="stylesheet" type="text/css" href="light.css" /> + <link rel="stylesheet" type="text/css" href="/$theme$.css" /> </head> <body class="body"> <header class="header"> @@ -13,13 +13,15 @@ </h1> <nav class="nav"> <a class="nav__link" - href="forgefed.html">π² behavior</a> + href="/forgefed$suffix$">π² behavior</a> <a class="nav__link" - href="forgefed-vocabulary.html">π vocabulary</a> + href="/forgefed-vocabulary$suffix$">π vocabulary</a> <a class="nav__link" href="https://notabug.org/peers/forgefed/issues">π issues</a> <a class="nav__link" href="https://talk.feneas.org/c/forgefed">πͺ forum</a> + <a class="nav__link" + href="$other-theme$.html">$other-theme-name$</a> </nav> </header> <main class="main"> diff --git a/specification/forgefed-vocabulary.md b/specification/forgefed-vocabulary.md index 2e4af54..43abea4 100644 --- a/specification/forgefed-vocabulary.md +++ b/specification/forgefed-vocabulary.md @@ -17,14 +17,14 @@ title: ForgeFed Vocabulary 2019 ... -## Abstract +# Abstract This document describes the ForgeFed vocabulary. It's intended to be an extension of the [ActivityPub Vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/) and provides additional vocabulary for federation of project management and version control system hosting and collaboration platforms. -## Introduction +# Introduction The ForgeFed Vocabulary describes a set of types and properties to be used by platforms that support the ForgeFed protocol. This specification describes only @@ -32,7 +32,7 @@ the new vocabulary called ForgeFed. The ForgeFed behavior specification describes how to use this vocabulary, along with standard ActivityPub vocabulary, to support the ForgeFed protocol. -## Types +# Types The base URI of all ForgeFed terms is `https://forgefed.peers.community/ns#`. The ForgeFed vocabulary has a JSON-LD context whose URI is @@ -51,9 +51,9 @@ A typical `@context` of a ForgeFed object may look like this: ] ``` -### Activity Types +## Activity Types -#### Push +### Push **URI:** `https://forgefed.peers.community/ns#Push` @@ -83,9 +83,9 @@ A Repository actor can use this Activity to notify followers of new changes. } ``` -### Actor Types +## Actor Types -#### Repository +### Repository **URI:** `https://forgefed.peers.community/ns#Repository` @@ -110,9 +110,9 @@ A Repository actor can use this Activity to notify followers of new changes. } ``` -### Object Types +## Object Types -#### Commit +### Commit **URI:** `https://forgefed.peers.community/ns#Commit` @@ -144,7 +144,7 @@ A Repository actor can use this Activity to notify followers of new changes. } ``` -#### TicketDependency +### TicketDependency **URI:** `https://forgefed.peers.community/ns#TicketDependency` @@ -174,7 +174,7 @@ be "dependsOn". } ``` -#### Ticket +### Ticket **URI:** `https://forgefed.peers.community/ns#Ticket` @@ -206,9 +206,9 @@ repository), and are used to track ideas, proposals, tasks, bugs and more. } ``` -## Properties +# Properties -### assignedTo +## assignedTo **URI:** `https://forgefed.peers.community/ns#assignedTo` @@ -224,7 +224,7 @@ repository), and are used to track ideas, proposals, tasks, bugs and more. **Example:** -### isResolved +## isResolved **URI:** `https://forgefed.peers.community/ns#isResolved` @@ -241,7 +241,7 @@ and it doesn't need to attract attention anymore. **Example:** -### dependsOn +## dependsOn **URI:** `https://forgefed.peers.community/ns#dependsOn` @@ -258,7 +258,7 @@ can't be resolved without those tickets being resolved too. **Example:** -### dependedBy +## dependedBy **URI:** `https://forgefed.peers.community/ns#dependedBy` @@ -275,7 +275,7 @@ they can't be resolved without this tickets being resolved too. **Example:** -### dependencies +## dependencies **URI:** `https://forgefed.peers.community/ns#dependencies` @@ -293,7 +293,7 @@ tickets that this ticket depends on, i.e. this ticket is the `subject` of the **Example:** -### dependants +## dependants **URI:** `https://forgefed.peers.community/ns#dependants` @@ -311,7 +311,7 @@ tickets that depends on this ticket, i.e. this ticket is the `object` of the **Example:** -### repository +## repository **URI:** `https://forgefed.peers.community/ns#repository` @@ -327,7 +327,7 @@ tickets that depends on this ticket, i.e. this ticket is the `object` of the **Example:** -### committedBy +## committedBy **URI:** `https://forgefed.peers.community/ns#committedBy` @@ -350,7 +350,7 @@ copy of the repository. **Example:** -### hash +## hash **URI:** `https://forgefed.peers.community/ns#hash` @@ -370,7 +370,7 @@ be the SHA1 hash of the patch info. **Example:** -### committed +## committed **URI:** `https://forgefed.peers.community/ns#committed` @@ -391,7 +391,7 @@ repository. We call the former event "created" and the latter event **Example:** -### filesAdded +## filesAdded **URI:** `https://forgefed.peers.community/ns#filesAdded` @@ -409,7 +409,7 @@ didn't exist in the previous version of the tree. **Example:** -### filesModified +## filesModified **URI:** `https://forgefed.peers.community/ns#filesModified` @@ -427,7 +427,7 @@ of the tree, and its contents got modified in this commit. **Example:** -### filesRemoved +## filesRemoved **URI:** `https://forgefed.peers.community/ns#filesRemoved` diff --git a/specification/forgefed.md b/specification/forgefed.md index f98f881..1496b54 100644 --- a/specification/forgefed.md +++ b/specification/forgefed.md @@ -17,7 +17,7 @@ title: ForgeFed 2019 ... -## Abstract +# Abstract This document describes the ForgeFed protocol. ForgeFed is an extension of the [ActivityPub](https://www.w3.org/TR/activitypub/) protocol for delivering @@ -26,20 +26,20 @@ The purpose of this specification is to describe a protocol that can be integrat into source code management for enabling collaboration across different platforms. -## Status of This Document +# Status of This Document -## Overview +# Overview ForgeFed is an extension of [ActivityPub](https://www.w3.org/TR/activitypub/) and follows the same "actors" model, with a client-to-server protocol and a server-to-server protocol. -## Conformance +# Conformance The key words MAY, MUST, MUST NOT, SHOULD, and SHOULD NOT are to be interpreted as described in [RFC2119]. -## Objects +# Objects Objects are the core concept around which both ActivityPub and ForgeFed are built. Examples of Objects are Note, Ticket, or Image. @@ -47,7 +47,7 @@ Objects are wrapped in Activities, a subtype of Object that describes some form of action that may happen, is currently happening, or has already happened. Examples of Activities are Create, Delete, or Follow. -## Actors +# Actors A ForgeFed implementation MUST provide an Actor of type `Repository` for every repository that should support federation. @@ -55,32 +55,32 @@ repository that should support federation. A ForgeFed implementation SHOULD provide an Actor of type `Person` for every user of the platform. -## Client to Server Interactions +# Client to Server Interactions ForgeFed uses Activities for client to server interactions, as described by ActivityPub. A client will send objects (eg. a Ticket) wrapped in a Activity (eg. Create) to an actor's outbox, and in turn the server will take care of delivery. -### Follow Activity +## Follow Activity The Follow activity is used to subscribe to the activities of a Repository. The client MUST send a Follow activity the a Person's outbox. The server in turn delivers the message to the destination inbox. -### Push Activity +## Push Activity The Push activity is used to notify followers when somebody has pushed changes to a Repository. The client MUST send a Push activity the a Repository's outbox. The server in turn delivers the message to the Repository followers. -## Server to Server Interactions +# Server to Server Interactions -### Follow Activity +## Follow Activity The server receiving a Follow activity in a Repository's inbox SHOULD add the sender actor to the Repository's followers collection. -## Acknowledgements +# Acknowledgements |