ICU-20088 User Guide migration: Initial setup with Jekyll and the Just-The-Docs theme.

Using the theme from: https://github.com/pmarsceill/just-the-docs
This commit is contained in:
Jeff Genovy 2020-08-06 18:04:51 -07:00
parent 9279e49d2f
commit 9889f37d3f
24 changed files with 215 additions and 1 deletions

53
docs/_config.yml Normal file
View file

@ -0,0 +1,53 @@
remote_theme: pmarsceill/just-the-docs
# GitHub uses it's own markdown renderer.
# We use this in order to try and have the docs pages match ones in the repo.
markdown: CommonMarkGhPages
# Plugins:
# jekyll-commonmark-ghpages -- This is needed in order to use CommonMarkGhPages
# jemoji -- For rendering emoji like :point_right:
plugins:
- jekyll-commonmark-ghpages
- jekyll-remote-theme
- jemoji
commonmark:
options: ["SMART", "FOOTNOTES"]
extensions: ["strikethrough", "autolink", "table", "tagfilter"]
title: ICU Documentation
description: ICU Documentation
baseurl: "/icu" # the subpath for the site
url: "https://jefgen.github.io" # the base hostname & protocol for your site
search_enabled: true
# Color scheme currently only supports "dark" or nil (default)
color_scheme: nil
# Aux links for the upper right navigation
aux_links:
"ICU on GitHub":
- "//github.com/jefgen/icu"
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
# Enable heading anchors
heading_anchors: true
# Footer content
# appears at the bottom of every page's main content
footer_content: "Copyright &copy; 2016 and later Unicode, Inc. and others. All Rights Reserved. <a href=\"http://www.unicode.org/copyright.html\">Terms of use and License</a>."
# TODO: I think this would be better at the top of the page, but I'm not sure how to do that.
# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/jefgen/icu" # the github URL for your repo
gh_edit_branch: "master" # the branch that your docs is served from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

View file

@ -1,3 +1,11 @@
---
layout: default
title: ICU Documentation
nav_order: 1
description: ICU Documentation
permalink: /
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html
@ -9,7 +17,7 @@ License & terms of use: http://www.unicode.org/copyright.html
## ICU User Guide
The [ICU User Guide](./userguide/) provides information on i18n topics for which ICU has services, and
The [ICU User Guide](./userguideintro) provides information on i18n topics for which ICU has services, and
includes details that go beyond the C, C++, and Java API docs (and avoids some duplication between them).
This is the new home of the User Guide (since 2020 August).

View file

@ -1,3 +1,10 @@
---
layout: default
title: Compression
permalink: /conversion/compression
nav_order: 4
parent: Conversion
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Converter
permalink: /conversion/converter
nav_order: 4
parent: Conversion
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Conversion Data
permalink: /conversion/data
nav_order: 4
parent: Conversion
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: CharSet Detection
permalink: /conversion/detection
nav_order: 4
parent: Conversion
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Conversion
permalink: /conversion
nav_order: 4
has_children: true
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: ICU Design
permalink: /design
nav_order: 5
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,9 @@
---
layout: default
title: Glossary
permalink: /glossary
nav_order: 9000
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: How To Use ICU
permalink: /howtouseicu
nav_order: 2
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Internationalization
permalink: /i18n
nav_order: 1
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: ICU4J Locale Service Provider
permalink: /icu4j-locale-service-provider
nav_order: 7
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Introduction
permalink: /userguideintro
nav_order: 2
has_children: true
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: C/POSIX Migration
permalink: /posix
nav_order: 6
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: ICU Services
permalink: /services
nav_order: 4
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: CharacterIterator
permalink: /characteriterator
nav_order: 3
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Chars and Strings
permalink: /strings
nav_order: 3
has_children: true
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Properties
permalink: /properties
nav_order: 2
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Regular Expressions
permalink: /regexp
nav_order: 6
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: StringPrep
permalink: /stringprep
nav_order: 7
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: UnicodeSet
permalink: /unicodeset
nav_order: 5
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: UText
permalink: /utext
nav_order: 4
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: UTF-8
permalink: /utf-8
nav_order: 1
parent: Chars and Strings
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html

View file

@ -1,3 +1,10 @@
---
layout: default
title: Unicode Basics
permalink: /unicode
nav_order: 3
parent: Introduction
---
<!--
© 2020 and later: Unicode, Inc. and others.
License & terms of use: http://www.unicode.org/copyright.html