forked from facebook/litho
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Back out "Remove Jekyll docs sources for good. Long live Docusaurus!"
Summary: build-break allow-large-files overriding_review_checks_triggers_an_audit_and_retroactive_review Oncall Short Name: litho Original commit changeset: 92966a65d8bf Differential Revision: D27291111 fbshipit-source-id: c5af4d8b21615f13765dc68b561623e506880668
- Loading branch information
1 parent
3dc4a27
commit 934c969
Showing
1,399 changed files
with
438,519 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /_site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| fblitho.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| This provides guidance on how to contribute various content to `fblitho.com`. | ||
|
|
||
| ## Getting started | ||
|
|
||
| You should only have to do these one time. | ||
|
|
||
| - Rename this file to `CONTRIBUTING.md`. | ||
| - Rename `EXAMPLE-README-FOR-RUNNING-DOCS.md` to `README.md` (replacing the existing `README.md` that came with the template). | ||
| - Rename `EXAMPLE-LICENSE` to `LICENSE`. | ||
| - Review the [template information](./TEMPLATE-INFORMATION.md). | ||
| - Review `./_config.yml`. | ||
| - Make sure you update `title`, `description`, `tagline` and `gacode` (Google Analytics) in `./_config.yml`. | ||
|
|
||
| ## Basic Structure | ||
|
|
||
| Most content is written in markdown. You name the file `something.md`, then have a header that looks like this: | ||
|
|
||
| ```yml | ||
| --- | ||
| docid: getting-started | ||
| title: Getting started with ProjectName | ||
| layout: docs | ||
| permalink: /docs/getting-started.html | ||
| --- | ||
| ``` | ||
|
|
||
| Customize these values for each document, blog post, etc. | ||
|
|
||
| > The filename of the `.md` file doesn't actually matter; what is important is the `docid` being unique and the `permalink` correct and unique too). | ||
| ## Landing page | ||
|
|
||
| Modify `index.md` with your new or updated content. | ||
|
|
||
| If you want a `GridBlock` as part of your content, you can do so directly with HTML: | ||
|
|
||
| ```html | ||
| <div class="gridBlock"> | ||
| <div class="blockElement twoByGridBlock alignLeft"> | ||
| <div class="blockContent"> | ||
| <h3>Your Features</h3> | ||
| <ul> | ||
| <li>The <a href="http://example.org/">Example</a></li> | ||
| <li><a href="http://example.com">Another Example</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="blockElement twoByGridBlock alignLeft"> | ||
| <div class="blockContent"> | ||
| <h3>More information</h3> | ||
| <p> | ||
| Stuff here | ||
| </p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ``` | ||
|
|
||
| or with a combination of changing `./_data/features.yml` and adding some Liquid to `index.md`, such as: | ||
|
|
||
| ``` | ||
| {% include content/gridblocks.html data_source=site.data.features imagealign="bottom"%} | ||
| ``` | ||
|
|
||
| ## Docs | ||
|
|
||
| To modify docs, edit the appropriate markdown file in `./_docs/`. | ||
|
|
||
| To add docs to the site.... | ||
|
|
||
| 1. Add your markdown file to the `./_docs/` folder. See `./doc-type-examples/docs-hello-world.md` for an example of the YAML header format. **If the `./_docs/` directory does not exist, create it**. | ||
| - You can use folders in the `./_docs/` directory to organize your content if you want. | ||
| 1. Update `_data/nav_docs.yml` to add your new document to the navigation bar. Use the `docid` you put in your doc markdown in as the `id` in the `_data/nav_docs.yml` file. | ||
| 1. [Run the site locally](./README.md) to test your changes. It will be at `http://127.0.0.1/docs/your-new-doc-permalink.html` | ||
| 1. Push your changes to GitHub. | ||
|
|
||
| ## Header Bar | ||
|
|
||
| To modify the header bar, change `./_data/nav.yml`. | ||
|
|
||
| ## Top Level Page | ||
|
|
||
| To modify a top-level page, edit the appropriate markdown file in `./top-level/` | ||
|
|
||
| If you want a top-level page (e.g., http://your-site.com/top-level.html) -- not in `/blog/` or `/docs/`.... | ||
|
|
||
| 1. Create a markdown file in the root `./top-level/`. See `./doc-type-examples/top-level-example.md` for more information. | ||
| 1. If you want a visible link to that file, update `_data/nav.yml` to add a link to your new top-level document in the header bar. | ||
|
|
||
| > This is not necessary if you just want to have a page that is linked to from another page, but not exposed as direct link to the user. | ||
| 1. [Run the site locally](./README.md) to test your changes. It will be at `http://127.0.0.1/your-top-level-page-permalink.html` | ||
| 1. Push your changes to GitHub. | ||
|
|
||
| ## Utilize `capture` and `markdownify` | ||
|
|
||
| If you want to use raw HTML but have some markdown-like content within it, you can do it through | ||
| `capture` and `markdownify`. | ||
|
|
||
| e.g. | ||
|
|
||
| ```html | ||
| {% capture landing-page-sample %}{% include_relative landing-page-sample.md %}{% endcapture %} | ||
|
|
||
| <div class="gridBlock alternateColor"> | ||
| <div class="blockElement twobyGridBlock imageAlignSide"> | ||
| <div class="blockContent"> | ||
| <div class="blockText"> | ||
| <p> | ||
| XXXXXXXXXXXXXXX | ||
| </p> | ||
| </div> | ||
| </div> | ||
| <div class="blockContent"> | ||
| <div class="blockCode"> | ||
| {{ landing-page-sample | markdownify }} | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ``` | ||
|
|
||
| This allows you to combine the best of full control with the simplicity of markdown. | ||
|
|
||
| ## Other Changes | ||
|
|
||
| - CSS: `./css/main.css` or `./_sass/*.scss`. | ||
| - Images: `./static/images/[docs | posts]/....` | ||
| - Main Blog post HTML: `./_includes/post.html` | ||
| - Main Docs HTML: `./_includes/doc.html` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| source 'https://rubygems.org' | ||
|
|
||
| gem 'github-pages', '~> 202', group: :jekyll_plugins |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,249 @@ | ||
| GEM | ||
| remote: https://rubygems.org/ | ||
| specs: | ||
| activesupport (4.2.11.1) | ||
| i18n (~> 0.7) | ||
| minitest (~> 5.1) | ||
| thread_safe (~> 0.3, >= 0.3.4) | ||
| tzinfo (~> 1.1) | ||
| addressable (2.7.0) | ||
| public_suffix (>= 2.0.2, < 5.0) | ||
| coffee-script (2.4.1) | ||
| coffee-script-source | ||
| execjs | ||
| coffee-script-source (1.11.1) | ||
| colorator (1.1.0) | ||
| commonmarker (0.17.13) | ||
| ruby-enum (~> 0.5) | ||
| concurrent-ruby (1.1.5) | ||
| dnsruby (1.61.3) | ||
| addressable (~> 2.5) | ||
| em-websocket (0.5.1) | ||
| eventmachine (>= 0.12.9) | ||
| http_parser.rb (~> 0.6.0) | ||
| ethon (0.12.0) | ||
| ffi (>= 1.3.0) | ||
| eventmachine (1.2.7) | ||
| execjs (2.7.0) | ||
| faraday (0.17.0) | ||
| multipart-post (>= 1.2, < 3) | ||
| ffi (1.11.1) | ||
| forwardable-extended (2.6.0) | ||
| gemoji (3.0.1) | ||
| github-pages (202) | ||
| activesupport (= 4.2.11.1) | ||
| github-pages-health-check (= 1.16.1) | ||
| jekyll (= 3.8.5) | ||
| jekyll-avatar (= 0.6.0) | ||
| jekyll-coffeescript (= 1.1.1) | ||
| jekyll-commonmark-ghpages (= 0.1.6) | ||
| jekyll-default-layout (= 0.1.4) | ||
| jekyll-feed (= 0.11.0) | ||
| jekyll-gist (= 1.5.0) | ||
| jekyll-github-metadata (= 2.12.1) | ||
| jekyll-mentions (= 1.4.1) | ||
| jekyll-optional-front-matter (= 0.3.0) | ||
| jekyll-paginate (= 1.1.0) | ||
| jekyll-readme-index (= 0.2.0) | ||
| jekyll-redirect-from (= 0.14.0) | ||
| jekyll-relative-links (= 0.6.0) | ||
| jekyll-remote-theme (= 0.4.0) | ||
| jekyll-sass-converter (= 1.5.2) | ||
| jekyll-seo-tag (= 2.5.0) | ||
| jekyll-sitemap (= 1.2.0) | ||
| jekyll-swiss (= 0.4.0) | ||
| jekyll-theme-architect (= 0.1.1) | ||
| jekyll-theme-cayman (= 0.1.1) | ||
| jekyll-theme-dinky (= 0.1.1) | ||
| jekyll-theme-hacker (= 0.1.1) | ||
| jekyll-theme-leap-day (= 0.1.1) | ||
| jekyll-theme-merlot (= 0.1.1) | ||
| jekyll-theme-midnight (= 0.1.1) | ||
| jekyll-theme-minimal (= 0.1.1) | ||
| jekyll-theme-modernist (= 0.1.1) | ||
| jekyll-theme-primer (= 0.5.3) | ||
| jekyll-theme-slate (= 0.1.1) | ||
| jekyll-theme-tactile (= 0.1.1) | ||
| jekyll-theme-time-machine (= 0.1.1) | ||
| jekyll-titles-from-headings (= 0.5.1) | ||
| jemoji (= 0.10.2) | ||
| kramdown (= 1.17.0) | ||
| liquid (= 4.0.0) | ||
| listen (= 3.1.5) | ||
| mercenary (~> 0.3) | ||
| minima (= 2.5.0) | ||
| nokogiri (>= 1.10.4, < 2.0) | ||
| rouge (= 3.11.0) | ||
| terminal-table (~> 1.4) | ||
| github-pages-health-check (1.16.1) | ||
| addressable (~> 2.3) | ||
| dnsruby (~> 1.60) | ||
| octokit (~> 4.0) | ||
| public_suffix (~> 3.0) | ||
| typhoeus (~> 1.3) | ||
| html-pipeline (2.12.0) | ||
| activesupport (>= 2) | ||
| nokogiri (>= 1.4) | ||
| http_parser.rb (0.6.0) | ||
| i18n (0.9.5) | ||
| concurrent-ruby (~> 1.0) | ||
| jekyll (3.8.5) | ||
| addressable (~> 2.4) | ||
| colorator (~> 1.0) | ||
| em-websocket (~> 0.5) | ||
| i18n (~> 0.7) | ||
| jekyll-sass-converter (~> 1.0) | ||
| jekyll-watch (~> 2.0) | ||
| kramdown (~> 1.14) | ||
| liquid (~> 4.0) | ||
| mercenary (~> 0.3.3) | ||
| pathutil (~> 0.9) | ||
| rouge (>= 1.7, < 4) | ||
| safe_yaml (~> 1.0) | ||
| jekyll-avatar (0.6.0) | ||
| jekyll (~> 3.0) | ||
| jekyll-coffeescript (1.1.1) | ||
| coffee-script (~> 2.2) | ||
| coffee-script-source (~> 1.11.1) | ||
| jekyll-commonmark (1.3.1) | ||
| commonmarker (~> 0.14) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-commonmark-ghpages (0.1.6) | ||
| commonmarker (~> 0.17.6) | ||
| jekyll-commonmark (~> 1.2) | ||
| rouge (>= 2.0, < 4.0) | ||
| jekyll-default-layout (0.1.4) | ||
| jekyll (~> 3.0) | ||
| jekyll-feed (0.11.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-gist (1.5.0) | ||
| octokit (~> 4.2) | ||
| jekyll-github-metadata (2.12.1) | ||
| jekyll (~> 3.4) | ||
| octokit (~> 4.0, != 4.4.0) | ||
| jekyll-mentions (1.4.1) | ||
| html-pipeline (~> 2.3) | ||
| jekyll (~> 3.0) | ||
| jekyll-optional-front-matter (0.3.0) | ||
| jekyll (~> 3.0) | ||
| jekyll-paginate (1.1.0) | ||
| jekyll-readme-index (0.2.0) | ||
| jekyll (~> 3.0) | ||
| jekyll-redirect-from (0.14.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-relative-links (0.6.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-remote-theme (0.4.0) | ||
| addressable (~> 2.0) | ||
| jekyll (~> 3.5) | ||
| rubyzip (>= 1.2.1, < 3.0) | ||
| jekyll-sass-converter (1.5.2) | ||
| sass (~> 3.4) | ||
| jekyll-seo-tag (2.5.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-sitemap (1.2.0) | ||
| jekyll (~> 3.3) | ||
| jekyll-swiss (0.4.0) | ||
| jekyll-theme-architect (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-cayman (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-dinky (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-hacker (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-leap-day (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-merlot (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-midnight (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-minimal (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-modernist (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-primer (0.5.3) | ||
| jekyll (~> 3.5) | ||
| jekyll-github-metadata (~> 2.9) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-slate (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-tactile (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-time-machine (0.1.1) | ||
| jekyll (~> 3.5) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-titles-from-headings (0.5.1) | ||
| jekyll (~> 3.3) | ||
| jekyll-watch (2.2.1) | ||
| listen (~> 3.0) | ||
| jemoji (0.10.2) | ||
| gemoji (~> 3.0) | ||
| html-pipeline (~> 2.2) | ||
| jekyll (~> 3.0) | ||
| kramdown (1.17.0) | ||
| liquid (4.0.0) | ||
| listen (3.1.5) | ||
| rb-fsevent (~> 0.9, >= 0.9.4) | ||
| rb-inotify (~> 0.9, >= 0.9.7) | ||
| ruby_dep (~> 1.2) | ||
| mercenary (0.3.6) | ||
| mini_portile2 (2.4.0) | ||
| minima (2.5.0) | ||
| jekyll (~> 3.5) | ||
| jekyll-feed (~> 0.9) | ||
| jekyll-seo-tag (~> 2.1) | ||
| minitest (5.13.0) | ||
| multipart-post (2.1.1) | ||
| nokogiri (1.10.8) | ||
| mini_portile2 (~> 2.4.0) | ||
| octokit (4.14.0) | ||
| sawyer (~> 0.8.0, >= 0.5.3) | ||
| pathutil (0.16.2) | ||
| forwardable-extended (~> 2.6) | ||
| public_suffix (3.1.1) | ||
| rb-fsevent (0.10.3) | ||
| rb-inotify (0.10.0) | ||
| ffi (~> 1.0) | ||
| rouge (3.11.0) | ||
| ruby-enum (0.7.2) | ||
| i18n | ||
| ruby_dep (1.5.0) | ||
| rubyzip (2.0.0) | ||
| safe_yaml (1.0.5) | ||
| sass (3.7.4) | ||
| sass-listen (~> 4.0.0) | ||
| sass-listen (4.0.0) | ||
| rb-fsevent (~> 0.9, >= 0.9.4) | ||
| rb-inotify (~> 0.9, >= 0.9.7) | ||
| sawyer (0.8.2) | ||
| addressable (>= 2.3.5) | ||
| faraday (> 0.8, < 2.0) | ||
| terminal-table (1.8.0) | ||
| unicode-display_width (~> 1.1, >= 1.1.1) | ||
| thread_safe (0.3.6) | ||
| typhoeus (1.3.1) | ||
| ethon (>= 0.9.0) | ||
| tzinfo (1.2.5) | ||
| thread_safe (~> 0.1) | ||
| unicode-display_width (1.6.0) | ||
|
|
||
| PLATFORMS | ||
| ruby | ||
|
|
||
| DEPENDENCIES | ||
| github-pages (~> 202) | ||
|
|
||
| BUNDLED WITH | ||
| 1.16.3 |
Oops, something went wrong.