From 6cab011d1b129de06109d2f259fc5ce55233beee Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Tue, 11 Aug 2015 16:48:17 -0700 Subject: [PATCH] version 3.0 of the theme -- complete overhaul --- .htaccess | 1 - Gemfile | 7 - Gemfile.lock | 127 - README.md | 7 +- _config.yml | 90 +- _data/glossary.yml | 12 +- _data/notes.yml | 10 - _data/options.yml | 15 - _data/sidebar.yml | 409 - _data/sidebar_doc.yml | 384 + _data/strings.yml | 1 + _data/{tags.yml => tags_doc.yml} | 7 +- _data/topnav.yml | 58 - _data/topnav_doc.yml | 46 + _drafts/_plugins/jekyll_lunr_js_search.rb | 248 + .../doc_gitcommands.md | 1 - _drafts/search.html | 55 + _drafts/use_git_to_download_theme.md | 10 - _includes/alerts.html | 3 +- _includes/custom/acme_series.html | 19 - _includes/custom/conditions.html | 30 +- _includes/custom/doc/customMenu.html | 12 + _includes/custom/doc/doc_homepage.md | 39 + _includes/custom/doc/links_doc.html | 120 + _includes/custom/doc/series_acme.html | 19 + _includes/custom/doc/series_acme_next.html | 10 + _includes/custom/homepage.md | 33 - _includes/custom/links.html | 60 - _includes/custom/toc_id_note.html | 1 - _includes/feedback.html | 16 + _includes/footer.html | 8 +- _includes/frameescape.html | 23 + _includes/head.html | 64 +- _includes/head_print.html | 29 + _includes/linkrefs.html | 3 +- _includes/pagemetadata.html | 35 - _includes/related_pages.html | 28 - _includes/related_posts.html | 19 - _includes/sidebar.html | 52 +- _includes/taglogic.html | 6 +- _includes/toc.html | 5 +- _includes/topnav.html | 178 +- _layouts/default.html | 23 +- _layouts/default_print.html | 23 +- _layouts/page.html | 24 +- _layouts/page_print.html | 1 - _layouts/post.html | 59 - _sass/_base.scss | 204 - _sass/_layout.scss | 236 - _sass/_syntax-highlighting.scss | 67 - archive.html | 21 - build_designer.sh | 1 - build_designer_pdf.sh | 6 - build_writer.sh | 1 - build_writer_pdf.sh | 6 - config_base.yml | 65 - config_designer.yml | 23 - config_designer_pdf.yml | 19 - config_writer.yml | 26 - config_writer_pdf.yml | 6 - configs/config_designers.yml | 63 + configs/config_designers_pdf.yml | 16 + configs/config_writers.yml | 64 + configs/config_writers_pdf.yml | 16 + css/bootstrap.css | 6566 ----------------- css/customstyles.css | 297 +- css/font-awesome.min.css | 2 +- css/fonts/FontAwesome.otf | Bin 0 -> 93888 bytes css/fonts/fontawesome-webfont.eot | Bin 0 -> 60767 bytes css/fonts/fontawesome-webfont.svg | 565 ++ css/fonts/fontawesome-webfont.ttf | Bin 0 -> 122092 bytes css/fonts/fontawesome-webfont.woff | Bin 0 -> 71508 bytes css/fonts/fontawesome-webfont.woff2 | Bin 0 -> 56780 bytes css/lavish-bootstrap.css | 13 +- css/print-header-designer.css | 42 - css/print-header-writer.css | 42 - css/printstyles.css | 170 +- css/projectstyles.css | 3 - css/theme-blue.css | 64 + css/theme-green.css | 63 + doc_about.md | 20 + ...ding_tooltips.md => doc_adding_tooltips.md | 5 +- pages/formatting/alerts.md => doc_alerts.md | 2 - ...ild_arguments.md => doc_build_arguments.md | 40 +- .../collections.md => doc_collections.md | 9 +- ...ional_logic.md => doc_conditional_logic.md | 105 +- ..._setup.md => doc_configuration_settings.md | 49 +- .../content_reuse.md => doc_content_reuse.md | 9 +- doc_customize_the_theme.md | 46 + doc_designers_pdf.pdf | Bin 0 -> 130827 bytes doc_excluding_files.md | 74 + .../special-layouts/faq.html => doc_faq.html | 1 - doc_generating_pdfs.md | 361 + doc_getting_started.md | 73 + doc_glossary.md | 93 + .../publishing/help_api.md => doc_help_api.md | 23 +- pages/formatting/icons.md => doc_icons.md | 10 +- pages/formatting/images.md => doc_images.md | 11 +- doc_kb_layout.md | 58 + pages/formatting/labels.md => doc_labels.md | 1 - doc_links.md | 98 + doc_multibuild_pdf.sh | 10 + doc_multibuild_web.sh | 23 + doc_multiscp.sh | 3 + doc_multiserve_pdf.sh | 16 + pages/formatting/navtabs.md => doc_navtabs.md | 11 +- doc_pages.md | 146 + doc_push_build_to_server.md | 26 + .../scroll.html => doc_scroll.html | 6 +- doc_search_configuration.md | 105 + doc_series.md | 99 + .../seriesdemo1.md => doc_seriesdemo1_0.md | 16 +- .../seriesdemo2.md => doc_seriesdemo1_1.md | 17 +- .../seriesdemo3.md => doc_seriesdemo1_2.md | 13 +- doc_seriesdemo1_3.md | 23 + .../shuffle.html => doc_shuffle.html | 41 +- doc_sidebar_navigation.md | 168 + doc_special_layouts.md | 29 + pages/overview/support.md => doc_support.md | 3 +- ...d_features.md => doc_supported_features.md | 23 +- doc_syntax_highlighting.md | 74 + pages/formatting/tables.md => doc_tables.md | 95 +- doc_tag-formatting.html | 5 + doc_tag-getting-started.html | 5 + doc_tag-navigation.html | 5 + doc_tag-publishing.html | 5 + doc_tag-single-sourcing.html | 5 + doc_tag-special-layouts.html | 5 + ...verview.md => doc_tag_archives_overview.md | 4 - doc_tags.md | 169 + doc_themes.md | 18 + doc_top_navigation.md | 54 + ...oubleshooting.md => doc_troubleshooting.md | 25 +- doc_video_embeds.md | 48 + doc_writers_pdf.pdf | Bin 0 -> 131707 bytes favicon.ico | Bin 0 -> 177352 bytes feed.xml | 10 +- files/atext_shortcuts.atext | Bin 10331 -> 0 bytes files/shortcuts.zip | Bin 7489 -> 0 bytes images/company_logo.png | Bin 0 -> 3105 bytes images/company_logo_big.png | Bin 0 -> 9588 bytes index.md | 22 +- ..._up_iterm_profiles.md => iterm_profiles.md | 19 +- js/customscripts.js | 12 +- js/lunr.min.js | 7 + js/search.min.js | 50 + js/toc.js | 2 +- latest_posts.html | 31 - multibuild.sh | 2 - news.md | 14 - pages/about.md | 14 - pages/content_types/pages.md | 124 - pages/content_types/posts.md | 16 - pages/formatting/links.md | 67 - pages/formatting/shortcuts.md | 16 - pages/formatting/syntax_highlighting.md | 39 - pages/formatting/videos.md | 29 - pages/navigation/navigation.md | 24 - pages/navigation/tags.md | 51 - pages/overview/getting_started.md | 116 - pages/publishing/create_pdf.md | 49 - pages/publishing/search_configuration.md | 60 - pages/single-sourcing/excluding_files.md | 32 - pages/special-layouts/kb_layout.md | 49 - pages/special-layouts/series.md | 105 - pages/special-layouts/special_layouts.md | 30 - pages/tag-archives/tag-content-types.md | 7 - pages/tag-archives/tag-formatting.html | 7 - pages/tag-archives/tag-getting_started.html | 7 - pages/tag-archives/tag-overview.html | 7 - pages/tag-archives/tag-publishing.html | 7 - pages/tag-archives/tag-single-sourcing.html | 7 - pages/tag-archives/tag-special-layouts.html | 7 - prince-file-list.txt | 13 +- search.json | 2 +- sitemap.xml | 2 +- tagindex.html | 39 - theme_license | 340 - titlepage.html | 73 +- tocpage.html | 41 + tooltip_demo.html | 7 +- 181 files changed, 4747 insertions(+), 10289 deletions(-) delete mode 100644 .htaccess delete mode 100644 Gemfile delete mode 100644 Gemfile.lock delete mode 100644 _data/notes.yml delete mode 100644 _data/options.yml delete mode 100644 _data/sidebar.yml create mode 100644 _data/sidebar_doc.yml rename _data/{tags.yml => tags_doc.yml} (77%) delete mode 100644 _data/topnav.yml create mode 100644 _data/topnav_doc.yml create mode 100644 _drafts/_plugins/jekyll_lunr_js_search.rb rename pages/publishing/gitcommands.md => _drafts/doc_gitcommands.md (92%) create mode 100644 _drafts/search.html delete mode 100644 _drafts/use_git_to_download_theme.md delete mode 100644 _includes/custom/acme_series.html create mode 100644 _includes/custom/doc/customMenu.html create mode 100644 _includes/custom/doc/doc_homepage.md create mode 100644 _includes/custom/doc/links_doc.html create mode 100644 _includes/custom/doc/series_acme.html create mode 100644 _includes/custom/doc/series_acme_next.html delete mode 100644 _includes/custom/homepage.md delete mode 100644 _includes/custom/links.html delete mode 100644 _includes/custom/toc_id_note.html create mode 100644 _includes/feedback.html create mode 100644 _includes/frameescape.html create mode 100644 _includes/head_print.html delete mode 100644 _includes/pagemetadata.html delete mode 100644 _includes/related_pages.html delete mode 100644 _includes/related_posts.html delete mode 100755 _layouts/post.html delete mode 100644 _sass/_base.scss delete mode 100644 _sass/_layout.scss delete mode 100644 _sass/_syntax-highlighting.scss delete mode 100644 archive.html delete mode 100644 build_designer.sh delete mode 100644 build_designer_pdf.sh delete mode 100644 build_writer.sh delete mode 100644 build_writer_pdf.sh delete mode 100644 config_base.yml delete mode 100644 config_designer.yml delete mode 100644 config_designer_pdf.yml delete mode 100644 config_writer.yml delete mode 100644 config_writer_pdf.yml create mode 100644 configs/config_designers.yml create mode 100644 configs/config_designers_pdf.yml create mode 100644 configs/config_writers.yml create mode 100644 configs/config_writers_pdf.yml delete mode 100755 css/bootstrap.css create mode 100644 css/fonts/FontAwesome.otf create mode 100644 css/fonts/fontawesome-webfont.eot create mode 100644 css/fonts/fontawesome-webfont.svg create mode 100644 css/fonts/fontawesome-webfont.ttf create mode 100644 css/fonts/fontawesome-webfont.woff create mode 100644 css/fonts/fontawesome-webfont.woff2 delete mode 100644 css/print-header-designer.css delete mode 100644 css/print-header-writer.css delete mode 100644 css/projectstyles.css create mode 100644 css/theme-blue.css create mode 100644 css/theme-green.css create mode 100644 doc_about.md rename pages/formatting/adding_tooltips.md => doc_adding_tooltips.md (81%) rename pages/formatting/alerts.md => doc_alerts.md (99%) rename pages/single-sourcing/build_arguments.md => doc_build_arguments.md (57%) rename pages/content_types/collections.md => doc_collections.md (57%) rename pages/single-sourcing/conditional_logic.md => doc_conditional_logic.md (53%) rename pages/overview/config_setup.md => doc_configuration_settings.md (54%) rename pages/single-sourcing/content_reuse.md => doc_content_reuse.md (63%) create mode 100644 doc_customize_the_theme.md create mode 100644 doc_designers_pdf.pdf create mode 100644 doc_excluding_files.md rename pages/special-layouts/faq.html => doc_faq.html (99%) create mode 100644 doc_generating_pdfs.md create mode 100644 doc_getting_started.md create mode 100644 doc_glossary.md rename pages/publishing/help_api.md => doc_help_api.md (96%) rename pages/formatting/icons.md => doc_icons.md (97%) rename pages/formatting/images.md => doc_images.md (63%) create mode 100644 doc_kb_layout.md rename pages/formatting/labels.md => doc_labels.md (98%) create mode 100644 doc_links.md create mode 100644 doc_multibuild_pdf.sh create mode 100644 doc_multibuild_web.sh create mode 100644 doc_multiscp.sh create mode 100644 doc_multiserve_pdf.sh rename pages/formatting/navtabs.md => doc_navtabs.md (86%) create mode 100644 doc_pages.md create mode 100644 doc_push_build_to_server.md rename pages/special-layouts/scroll.html => doc_scroll.html (99%) create mode 100644 doc_search_configuration.md create mode 100644 doc_series.md rename pages/special-layouts/seriesdemo1.md => doc_seriesdemo1_0.md (87%) rename pages/special-layouts/seriesdemo2.md => doc_seriesdemo1_1.md (86%) rename pages/special-layouts/seriesdemo3.md => doc_seriesdemo1_2.md (89%) create mode 100644 doc_seriesdemo1_3.md rename pages/special-layouts/shuffle.html => doc_shuffle.html (72%) create mode 100644 doc_sidebar_navigation.md create mode 100644 doc_special_layouts.md rename pages/overview/support.md => doc_support.md (92%) rename pages/overview/supported_features.md => doc_supported_features.md (50%) create mode 100644 doc_syntax_highlighting.md rename pages/formatting/tables.md => doc_tables.md (57%) create mode 100644 doc_tag-formatting.html create mode 100644 doc_tag-getting-started.html create mode 100644 doc_tag-navigation.html create mode 100644 doc_tag-publishing.html create mode 100644 doc_tag-single-sourcing.html create mode 100644 doc_tag-special-layouts.html rename pages/tag-archives/tag-archives-overview.md => doc_tag_archives_overview.md (69%) create mode 100644 doc_tags.md create mode 100644 doc_themes.md create mode 100644 doc_top_navigation.md rename pages/overview/troubleshooting.md => doc_troubleshooting.md (53%) create mode 100644 doc_video_embeds.md create mode 100644 doc_writers_pdf.pdf create mode 100644 favicon.ico delete mode 100644 files/atext_shortcuts.atext delete mode 100644 files/shortcuts.zip create mode 100644 images/company_logo.png create mode 100644 images/company_logo_big.png rename pages/publishing/setting_up_iterm_profiles.md => iterm_profiles.md (84%) create mode 100644 js/lunr.min.js create mode 100644 js/search.min.js delete mode 100644 latest_posts.html delete mode 100644 multibuild.sh delete mode 100644 news.md delete mode 100644 pages/about.md delete mode 100644 pages/content_types/pages.md delete mode 100644 pages/content_types/posts.md delete mode 100644 pages/formatting/links.md delete mode 100644 pages/formatting/shortcuts.md delete mode 100644 pages/formatting/syntax_highlighting.md delete mode 100644 pages/formatting/videos.md delete mode 100644 pages/navigation/navigation.md delete mode 100644 pages/navigation/tags.md delete mode 100644 pages/overview/getting_started.md delete mode 100644 pages/publishing/create_pdf.md delete mode 100644 pages/publishing/search_configuration.md delete mode 100644 pages/single-sourcing/excluding_files.md delete mode 100644 pages/special-layouts/kb_layout.md delete mode 100644 pages/special-layouts/series.md delete mode 100644 pages/special-layouts/special_layouts.md delete mode 100644 pages/tag-archives/tag-content-types.md delete mode 100644 pages/tag-archives/tag-formatting.html delete mode 100644 pages/tag-archives/tag-getting_started.html delete mode 100644 pages/tag-archives/tag-overview.html delete mode 100644 pages/tag-archives/tag-publishing.html delete mode 100644 pages/tag-archives/tag-single-sourcing.html delete mode 100644 pages/tag-archives/tag-special-layouts.html delete mode 100644 tagindex.html delete mode 100644 theme_license create mode 100644 tocpage.html diff --git a/.htaccess b/.htaccess deleted file mode 100644 index b741439..0000000 --- a/.htaccess +++ /dev/null @@ -1 +0,0 @@ -Header add Access-Control-Allow-Origin "*" \ No newline at end of file diff --git a/Gemfile b/Gemfile deleted file mode 100644 index 4ff71a3..0000000 --- a/Gemfile +++ /dev/null @@ -1,7 +0,0 @@ -source 'https://rubygems.org' - -require 'json' -require 'open-uri' -versions = JSON.parse(open('https://pages.github.com/versions.json').read) - -gem 'github-pages', versions['github-pages'] \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index 812f062..0000000 --- a/Gemfile.lock +++ /dev/null @@ -1,127 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - RedCloth (4.2.9) - activesupport (4.2.1) - i18n (~> 0.7) - json (~> 1.7, >= 1.7.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) - blankslate (2.1.2.4) - celluloid (0.16.0) - timers (~> 4.0.0) - classifier-reborn (2.0.3) - fast-stemmer (~> 1.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.9.1.1) - colorator (0.1) - execjs (2.5.2) - fast-stemmer (1.0.2) - ffi (1.9.8) - gemoji (2.1.0) - github-pages (35) - RedCloth (= 4.2.9) - github-pages-health-check (~> 0.2) - jekyll (= 2.4.0) - jekyll-coffeescript (= 1.0.1) - jekyll-mentions (= 0.2.1) - jekyll-redirect-from (= 0.6.2) - jekyll-sass-converter (= 1.2.0) - jekyll-sitemap (= 0.8.1) - jemoji (= 0.4.0) - kramdown (= 1.5.0) - liquid (= 2.6.2) - maruku (= 0.7.0) - mercenary (~> 0.3) - pygments.rb (= 0.6.1) - rdiscount (= 2.1.7) - redcarpet (= 3.1.2) - terminal-table (~> 1.4) - github-pages-health-check (0.3.1) - net-dns (~> 0.6) - public_suffix (~> 1.4) - hitimes (1.2.2) - html-pipeline (1.9.0) - activesupport (>= 2) - nokogiri (~> 1.4) - i18n (0.7.0) - jekyll (2.4.0) - classifier-reborn (~> 2.0) - colorator (~> 0.1) - jekyll-coffeescript (~> 1.0) - jekyll-gist (~> 1.0) - jekyll-paginate (~> 1.0) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) - kramdown (~> 1.3) - liquid (~> 2.6.1) - mercenary (~> 0.3.3) - pygments.rb (~> 0.6.0) - redcarpet (~> 3.1) - safe_yaml (~> 1.0) - toml (~> 0.1.0) - jekyll-coffeescript (1.0.1) - coffee-script (~> 2.2) - jekyll-gist (1.2.1) - jekyll-mentions (0.2.1) - html-pipeline (~> 1.9.0) - jekyll (~> 2.0) - jekyll-paginate (1.1.0) - jekyll-redirect-from (0.6.2) - jekyll (~> 2.0) - jekyll-sass-converter (1.2.0) - sass (~> 3.2) - jekyll-sitemap (0.8.1) - jekyll-watch (1.2.1) - listen (~> 2.7) - jemoji (0.4.0) - gemoji (~> 2.0) - html-pipeline (~> 1.9) - jekyll (~> 2.0) - json (1.8.2) - kramdown (1.5.0) - liquid (2.6.2) - listen (2.10.0) - celluloid (~> 0.16.0) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9) - maruku (0.7.0) - mercenary (0.3.5) - mini_portile (0.6.2) - minitest (5.6.1) - net-dns (0.8.0) - nokogiri (1.6.6.2) - mini_portile (~> 0.6.0) - parslet (1.5.0) - blankslate (~> 2.0) - posix-spawn (0.3.11) - public_suffix (1.5.1) - pygments.rb (0.6.1) - posix-spawn (~> 0.3.6) - yajl-ruby (~> 1.2.0) - rb-fsevent (0.9.4) - rb-inotify (0.9.5) - ffi (>= 0.5.0) - rdiscount (2.1.7) - redcarpet (3.1.2) - safe_yaml (1.0.4) - sass (3.4.13) - terminal-table (1.4.5) - thread_safe (0.3.5) - timers (4.0.1) - hitimes - toml (0.1.2) - parslet (~> 1.5.0) - tzinfo (1.2.2) - thread_safe (~> 0.1) - yajl-ruby (1.2.1) - -PLATFORMS - ruby - -DEPENDENCIES - github-pages (= 35) - json diff --git a/README.md b/README.md index 57e883a..3878ec9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Documentation theme for Jekyll -This is a Jekyll theme designed to be used for single-sourced documentation sites. Instructions for using the theme are in the site build. +This is a Jekyll theme designed to be used for single-sourced documentation sites. Instructions for using the theme are in the site build. You can see the site build in the following two locations: -The basic idea of this theme is that you can use the same theme to create lots of different sites, such as what you would need if producing different help systems for different versions, models, etc. of a similar product. +* [http://idratherbewriting.com/documentation-theme-jekyll/designer/](http://idratherbewriting.com/documentation-theme-jekyll/designer/) +* [http://idratherbewriting.com/documentation-theme-jekyll/writer/](http://idratherbewriting.com/documentation-theme-jekyll/writer/) -Once you build the site, see the Getting Started section of the sidebar. +The two different builds demonstrate the single-source publishing capabilities of the theme. The designer version is comprehensive, whereas the writer version is a subset of the designer version. diff --git a/_config.yml b/_config.yml index caa3f8e..630a10d 100644 --- a/_config.yml +++ b/_config.yml @@ -1,59 +1,46 @@ -project: documentation-theme-jekyll-designer - -audience: designer - +## This content is duplicated here from configs/config_designers.yml because I'm building this site through Github Pages, and Github Pages just looks for the _config.yml file in the root directory to create the build. +project: doc +audience: designers product: all - platform: all - version: all - -topnav_title: Jekyll for Designers - -topnav_version: 2.1 - -homepage_title: Doc theme for Jekyll - -site_title: Documentation theme for Jekyll - -tagline: Guide for designers - -baseurl: "/documentation-theme-jekyll" - -port: 4006 - -host: 127.0.0.1 - -url: "http://tomjohnson1492.github.io" - -feedback_email: tomjohnson1492@gmail.com - -sidebar_accordion: true - +destination: /Applications/XAMPP/xamppfiles/htdocs/jekyll-documentation-theme/designers +topnav_title: Jekyll Documentation Theme +homepage_title: Jekyll Documentation Theme — Designers +site_title: Jekyll Documentation Theme — Designers disqus_shortname: idrbwjekyll -google_analytics: UA-408430-5 +# variables +sidebar_tagline: designers +sidebar_version: version 3.0 + +port: 4001 + +exclude: + - doc_writer* + - configs/ + - _site + - di_multi* + +# same for all +host: 127.0.0.1 +feedback_email: tomjohnson1492@gmail.com +sidebar_accordion: true markdown: redcarpet +print: false +theme_file: theme-blue.css +# only use suffix if you need to force index.html to display +# suffix: index.html redcarpet: - extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"] + extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"] highlighter: pygments -print: false - -floating_nav: true - -# suffix: index.html - -exclude: - - _drafts - - bower_components - - .idea - - _site - -permalink: :title +collections: + tooltips: + output: true defaults: - @@ -72,18 +59,3 @@ defaults: layout: "post" comments: true search: true - - - scope: - path: "" - type: "tooltips" - values: - layout: "page" - tooltip: true - search: true - -sass: - sass_dir: _sass - -collections: - tooltips: - output: true \ No newline at end of file diff --git a/_data/glossary.yml b/_data/glossary.yml index f222a8a..e953fe7 100644 --- a/_data/glossary.yml +++ b/_data/glossary.yml @@ -1 +1,11 @@ -jekyll_platform: "an extremely fast and simple static site generator" +jekyll_platform: "Jekyll is a static site generator that builds sites using most modern web technologies." + +fractious: "Like a little mischevious child, full of annoying and constant trouble." + +gratuitous: "Something that is unwarranted and uncouth, like the social equivalent of a flagrant foul." + +haughty: "Proud and flaunting it. Holding your head high up like a snooty, too-good-for-everything rich person." + +impertinent: "Someone acting rude and insensitive to others." + +intrepid: "Brave and courageous especially in a difficult, dangerous situation." \ No newline at end of file diff --git a/_data/notes.yml b/_data/notes.yml deleted file mode 100644 index 80e8b82..0000000 --- a/_data/notes.yml +++ /dev/null @@ -1,10 +0,0 @@ ---- -videonote: > - This is a sample note. Everything under the note title needs to be indented one space. The > means that - you start the string on the next line. - -samplenote: "something else" - -another_note: "hey there" - - diff --git a/_data/options.yml b/_data/options.yml deleted file mode 100644 index 184dad8..0000000 --- a/_data/options.yml +++ /dev/null @@ -1,15 +0,0 @@ -# You can store various options here, such as audience. Then you can access the option with {{site.data.options.audience}}. -# This allows you to do conditional logic. Options you set here work similarly to options set in the configuration file, -# but the advantage here is that you don't have to restart the jekyll server to see changes. Also note that you access this location -# using site.data instead of just site. And the location of data is defined in the configuration file through the data-source property. - -# Sample logic: -# {% if {{site.data.options.widget_toggle}} == "mac" %} -# do this for mac -# {% elsif {{site.data.options.widget_toggle}} == "pc" %} -# do this for pc -# {% endif %} - -# This logic works in Markdown and HTML. You can compress onto the same line if the spacing creates issues in Markdown. - -widget_toggle: mac \ No newline at end of file diff --git a/_data/sidebar.yml b/_data/sidebar.yml deleted file mode 100644 index cb3fd1c..0000000 --- a/_data/sidebar.yml +++ /dev/null @@ -1,409 +0,0 @@ -# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. -# Spacing is really important here. A two-space indent appears below each level to indicate a new depth. -# -# Sidebar -entries: -- title: Sidebar # this title doesn't appear anywhere - subcategories: - - title: Overview - audience: writer, designer - platform: all - product: all - version: all - print: true - - items: - - title: Cover - url: /titlepage/ - audience: writer, designer - platform: all - product: all - version: all - print: true - web: false - - - title: Getting started - url: /getting_started/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Setting up the configuration files - url: /config_setup/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Supported features - url: /supported_features/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Troubleshooting - url: /troubleshooting/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Content types - audience: writer, designer - platform: all - product: all - version: all - print: true - - items: - - title: Pages and posts - url: /pages/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Collections - url: /collections/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Formatting - audience: writer, designer - platform: all - product: all - version: all - print: true - - items: - - - title: Alerts - url: /alerts/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Images - url: /images/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Links - url: /links/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Syntax highlighting - url: /syntax_highlighting/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Videos - url: /videos/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Labels - url: /labels/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Icons - url: /icons/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Tables - url: /tables/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Tooltips - url: /adding_tooltips/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Navtabs - url: /navtabs/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Shortcuts for Jekyll syntax - url: /shortcuts_for_jekyll_syntax/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Single Sourcing - audience: writer, designer - platform: all - product: all - version: all - print: true - - items: - - title: Conditional logic - url: /conditional_logic/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Content re-use - url: /content_reuse/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Excluding files - url: /excluding_files/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Publishing - audience: writer, designer - platform: all - product: all - version: all - print: true - - items: - - title: Build arguments - url: /build_arguments/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Create a PDF - url: /create_pdf/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Creating a help API - url: /help_api/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Setting up iTerm profiles - url: /iterm_profiles/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Common Git commands - url: /git_commands/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Navigation - audience: writer - platform: all - product: all - version: all - print: true - items: - - title: Configuring sidebar and top navigation - url: /navigation/ - audience: designer, writer - platform: all - product: all - version: all - print: true - - - title: Tags - url: /tags/ - audience: writer, designer - platform: all - product: all - version: all - print: true - - - title: Special Layouts - audience: designer, writer - platform: all - product: all - version: all - print: true - print: false - items: - - title: Special layouts - url: /special_layouts/ - audience: designer - platform: all - product: all - version: all - print: true - - - title: Creating a series - url: /series/ - audience: designer - platform: all - product: all - version: all - print: all - - - title: FAQ layout - url: /faq/ - audience: designer - platform: all - product: all - version: all - print: true - - - title: KB layout - url: /kb_layout/ - audience: designer - platform: all - product: all - version: all - print: true - - - title: Scroll - url: /scroll/ - audience: designer - platform: all - product: all - version: all - print: true - - - title: Shuffle - url: /shuffle/ - audience: designer - platform: all - product: all - version: all - print: true - - - title: Tag archives - audience: designer, writer - platform: all - product: all - version: all - print: false - - items: - - title: Overview - url: /tag-archives-overview/ - audience: writer, designer - platform: all - product: all - version: all - print: false - - thirdlevel: #demo's how to add a third level to the sidebar nav. - - title: Third level title - audience: writer, designer - platform: all - product: all - version: all - print: false - - thirdlevelitems: - - title: Overview pages - url: /tag-overview/ - audience: writer, designer - platform: all - product: all - version: all - print: false - - - title: Getting Started pages - url: /tag-getting-started/ - audience: writer, designer - platform: all - product: all - version: all - print: false - - - title: Single Sourcing pages - url: /tag-single-sourcing/ - audience: writer, designer - platform: all - product: all - version: all - print: false - - - title: Publishing pages - url: /tag-publishing/ - audience: writer, designer - platform: all - product: all - version: all - print: false - - - title: Formatting pages - url: /tag-formatting/ - audience: writer, designer - platform: all - product: all - version: all - print: false - - - title: Special layout pages - url: /tag-special-layouts/ - audience: writer, designer - platform: all - product: all - version: all - print: false - diff --git a/_data/sidebar_doc.yml b/_data/sidebar_doc.yml new file mode 100644 index 0000000..f7a4efd --- /dev/null +++ b/_data/sidebar_doc.yml @@ -0,0 +1,384 @@ +# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting. + +# Sidebar +entries: +- title: Sidebar + subcategories: + - title: Frontmatter # leave this frontmatter section here for PDF outputs + audience: writers, designers + platform: all + product: all + version: all + web: false + items: + - title: Title Page + url: /titlepage.html + audience: writers, designers + platform: all + product: all + version: all + web: false + + - title: Table of Contents + url: /tocpage.html + audience: writers, designers + platform: all + product: all + version: all + web: false + + - title: Getting started + audience: writers, designers + platform: all + product: all + version: all + print: true + + items: + - title: Get started with this theme + url: /doc_getting_started.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Configuration options + url: /doc_configuration_settings.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Customizing the theme + url: /doc_customize_the_theme.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Supported features + url: /doc_supported_features.html + audience: writers, designers + platform: all + product: all + version: all + + + - title: Authoring + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + - title: Pages + url: /doc_pages.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Series + url: /doc_series.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Collections + url: /doc_collections.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Navigation + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + - title: Sidebar navigation + url: /doc_sidebar_navigation.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Top navigation + url: /doc_top_navigation.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Tags + url: /doc_tags.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Formatting + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + - title: Tooltips + url: /doc_adding_tooltips.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Alerts + url: /doc_alerts.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Icons + url: /doc_icons.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Images + url: /doc_images.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Labels + url: /doc_labels.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Links + url: /doc_links.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Navtabs + url: /doc_navtabs.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Video embeds + url: /doc_video_embeds.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Tables + url: /doc_tables.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Syntax highlighting + url: /doc_syntax_highlighting.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Single-sourcing + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + + - title: Conditional logic + url: /doc_conditional_logic.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Content reuse + url: /doc_content_reuse.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Publishing + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + + - title: Build arguments + url: /doc_build_arguments.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Themes + url: /doc_themes.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Generating PDFs + url: /doc_generating_pdfs.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Exclude files + url: /doc_excluding_files.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Help API and UI tooltips + url: /doc_help_api.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Search configuration + url: /doc_search_configuration.html + audience: writers, designers + platform: all + product: all + version: all + + - title: iTerm profiles + url: /iterm_profiles.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Pushing builds to server + url: /doc_push_build_to_server.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Special layouts + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + + - title: Knowledge-base layout + url: /doc_kb_layout.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Scroll layout + url: /doc_scroll.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Shuffle + url: /doc_shuffle.html + audience: writers, designers + platform: all + product: all + version: all + + - title: FAQ pages + url: /doc_faq.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Glossaries + url: /doc_glossary.html + audience: writers, designers + platform: all + product: all + version: all + + - title: Tag archives + audience: writers, designers + platform: all + product: all + version: all + print: true + items: + + - title: Tag archives overview + url: /doc_tag_archives_overview.html + audience: writers, designers + platform: all + product: all + version: all + + thirdlevel: + - title: Tag archive pages + audience: writers, designers + platform: all + version: all + product: all + thirdlevelitems: + - title: Getting started pages + url: /doc_tag-getting-started.html + audience: writers, designers + platform: all + version: all + product: all + + - title: Formatting pages + url: /doc_tag-formatting.html + audience: writers, designers + platform: all + version: all + product: all + + - title: Navigation pages + url: /doc_tag-navigation.html + audience: writers, designers + platform: all + version: all + product: all + + - title: Publishing pages + url: /doc_tag-publishing.html + audience: writers, designers + platform: all + version: all + product: all + + - title: Special layout pages + url: /doc_special-layouts.html + audience: writers, designers + platform: all + version: all + product: all diff --git a/_data/strings.yml b/_data/strings.yml index d7c1392..df0ee61 100644 --- a/_data/strings.yml +++ b/_data/strings.yml @@ -3,3 +3,4 @@ # placed here for translation purposes search_placeholder_text: search... search_no_results_text: No results found. +copyright_line: "©2015 Company Name. All rights reserved." diff --git a/_data/tags.yml b/_data/tags_doc.yml similarity index 77% rename from _data/tags.yml rename to _data/tags_doc.yml index 372132b..ea7e068 100644 --- a/_data/tags.yml +++ b/_data/tags_doc.yml @@ -1,12 +1,9 @@ -allowed-tags: +allowed-tags: - getting-started - - overview + - navigation - formatting - publishing - single-sourcing - special-layouts - content types - - - diff --git a/_data/topnav.yml b/_data/topnav.yml deleted file mode 100644 index 7213679..0000000 --- a/_data/topnav.yml +++ /dev/null @@ -1,58 +0,0 @@ -# if you want to list an external url, use external_url instead of url. the theme will apply a different link base. - -# Topnav single links -topnav: -- title: Topnav - subcategories: - - title: About - url: /about/ - audience: writer, designer - platform: all - product: all - version: all - - - title: Github repo - external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll - audience: writer, designer - platform: all - product: all - version: all - - - title: My blog - external_url: http://idratherbewriting.com - audience: writer, designer - platform: all - product: all - version: all - -#Topnav dropdowns -topnav_dropdowns: -- title: Topnav dropdowns - subcategories: - - title: Jekyll resources - audience: writer, designer - platform: all - product: all - version: all - - items: - - title: Jekyll documentation - external_url: http://jekyllrb.com/docs/home/ - audience: writer, designer - platform: all - product: all - version: all - - - title: Jekyll Talk - external_url: https://talk.jekyllrb.com/ - audience: designer, writer - platform: all - product: all - version: all - - - title: Jekyll on Stackoverflow - external_url: http://stackoverflow.com/questions/tagged/jekyll - audience: writer, designer - platform: all - product: all - version: all diff --git a/_data/topnav_doc.yml b/_data/topnav_doc.yml new file mode 100644 index 0000000..739a726 --- /dev/null +++ b/_data/topnav_doc.yml @@ -0,0 +1,46 @@ +# Topnav single links +# if you want to list an external url, use external_url instead of url. the theme will apply a different link base. +topnav: +- title: Topnav + subcategories: + - title: Github Repo + external_url: https://github.com/tomjohnson1492/documentation-theme-jekyll + audience: writers, designers + platform: all + product: all + version: all + +#Topnav dropdowns +topnav_dropdowns: +- title: Topnav dropdowns + subcategories: + - title: Resources + audience: writers, designers + platform: all + product: all + version: all + items: + - title: About + url: /doc_about.html + audience: writers, designers + platform: all + product: all + version: all + - title: Support + url: /doc_support.html + audience: writers, designers + platform: all + product: all + version: all + - title: Troubleshooting + url: /doc_troubleshooting.html + audience: writers, designers + platform: all + product: all + version: all + - title: Jekyll Talk + external_url: https://talk.jekyllrb.com + audience: writers, designers + platform: all + product: all + version: all \ No newline at end of file diff --git a/_drafts/_plugins/jekyll_lunr_js_search.rb b/_drafts/_plugins/jekyll_lunr_js_search.rb new file mode 100644 index 0000000..b93f81a --- /dev/null +++ b/_drafts/_plugins/jekyll_lunr_js_search.rb @@ -0,0 +1,248 @@ +require 'fileutils' +require 'net/http' +require 'json' +require 'uri' +require 'v8' + +module Jekyll + module LunrJsSearch + class Indexer < Jekyll::Generator + def initialize(config = {}) + super(config) + + lunr_config = { + 'excludes' => [], + 'strip_index_html' => false, + 'min_length' => 3, + 'stopwords' => 'stopwords.txt', + 'fields' => { + 'title' => 10, + 'tags' => 20, + 'body' => 1 + }, + 'js_dir' => 'js' + }.merge!(config['lunr_search'] || {}) + + @js_dir = lunr_config['js_dir'] + gem_lunr = File.join(File.dirname(__FILE__), "../../build/lunr.min.js") + @lunr_path = File.exist?(gem_lunr) ? gem_lunr : File.join(@js_dir, File.basename(gem_lunr)) + raise "Could not find #{@lunr_path}" if !File.exist?(@lunr_path) + + ctx = V8::Context.new + ctx.load(@lunr_path) + ctx['indexer'] = proc do |this| + this.ref('id') + lunr_config['fields'].each_pair do |name, boost| + this.field(name, { 'boost' => boost }) + end + end + @index = ctx.eval('lunr(indexer)') + @lunr_version = ctx.eval('lunr.version') + @docs = {} + @excludes = lunr_config['excludes'] + + # if web host supports index.html as default doc, then optionally exclude it from the url + @strip_index_html = lunr_config['strip_index_html'] + + # stop word exclusion configuration + @min_length = lunr_config['min_length'] + @stopwords_file = lunr_config['stopwords'] + end + + # Index all pages except pages matching any value in config['lunr_excludes'] or with date['exclude_from_search'] + # The main content from each page is extracted and saved to disk as json + def generate(site) + Jekyll.logger.info "Lunr:", 'Creating search index...' + + @site = site + # gather pages and posts + items = pages_to_index(site) + content_renderer = PageRenderer.new(site) + index = [] + + items.each_with_index do |item, i| + entry = SearchEntry.create(item, content_renderer) + + entry.strip_index_suffix_from_url! if @strip_index_html + entry.strip_stopwords!(stopwords, @min_length) if File.exists?(@stopwords_file) + + doc = { + "id" => i, + "title" => entry.title, + "url" => entry.url, + "date" => entry.date, + "categories" => entry.categories, + "body" => entry.body + } + @index.add(doc) + doc.delete("body") + @docs[i] = doc + + Jekyll.logger.debug "Lunr:", (entry.title ? "#{entry.title} (#{entry.url})" : entry.url) + end + + FileUtils.mkdir_p(File.join(site.dest, @js_dir)) + filename = File.join(@js_dir, 'index.json') + + total = { + "docs" => @docs, + "index" => @index.to_hash + } + + filepath = File.join(site.dest, filename) + File.open(filepath, "w") { |f| f.write(total.to_json(:max_nesting => 150)) } + Jekyll.logger.info "Lunr:", "Index ready (lunr.js v#{@lunr_version})" + added_files = [filename] + + site_js = File.join(site.dest, @js_dir) + # If we're using the gem, add the lunr and search JS files to the _site + if File.expand_path(site_js) != File.dirname(@lunr_path) + extras = Dir.glob(File.join(File.dirname(@lunr_path), "*.min.js")) + FileUtils.cp(extras, site_js) + extras.map! { |min| File.join(@js_dir, File.basename(min)) } + Jekyll.logger.debug "Lunr:", "Added JavaScript to #{@js_dir}" + added_files.push(*extras) + end + + # Keep the written files from being cleaned by Jekyll + added_files.each do |filename| + site.static_files << SearchIndexFile.new(site, site.dest, "/", filename) + end + end + + private + + # load the stopwords file + def stopwords + @stopwords ||= IO.readlines(@stopwords_file).map { |l| l.strip } + end + + def output_ext(doc) + if doc.is_a?(Jekyll::Document) + Jekyll::Renderer.new(@site, doc).output_ext + else + doc.output_ext + end + end + + def pages_to_index(site) + items = [] + + # deep copy pages + site.pages.each {|page| items << page.dup } + site.posts.each {|post| items << post.dup } + site.documents.each {|document| items << document.dup } + + # only process files that will be converted to .html and only non excluded files + items.select! {|i| output_ext(i) == '.html' && ! @excludes.any? {|s| (i.url =~ Regexp.new(s)) != nil } } + items.reject! {|i| i.data['exclude_from_search'] } + + items + end + end + end +end +require "v8" +require "json" + +class V8::Object + def to_json + @context['JSON']['stringify'].call(self) + end + + def to_hash + JSON.parse(to_json, :max_nesting => 150) + end +end +require 'nokogiri' + +module Jekyll + module LunrJsSearch + class PageRenderer + def initialize(site) + @site = site + end + + def prepare(item) + if item.is_a?(Jekyll::Document) + Jekyll::Renderer.new(@site, item).run + else + item.data = item.data.dup + item.data.delete("layout") + item.render({}, @site.site_payload) + item.output + end + end + + # render the item, parse the output and get all text inside

elements + def render(item) + item.render(@site.layouts, @site.site_payload) + doc = Nokogiri::HTML(item.output) + article = doc.search('article').map {|t| t.content } + article.join(" ").gsub("\r", " ").gsub("\n", " ").gsub("\t", " ").gsub(/\s+/, " ").split.join(" ") + end + end + end +end +require 'nokogiri' + +module Jekyll + module LunrJsSearch + class SearchEntry + def self.create(page_or_post, renderer) + case page_or_post + when Jekyll::Post + date = page_or_post.date + categories = page_or_post.categories + when Jekyll::Page, Jekyll::Document + date = nil + categories = [] + else + raise 'Not supported' + end + title, url = extract_title_and_url(page_or_post) + body = renderer.render(page_or_post) + + SearchEntry.new(title, url, date, categories, body, renderer) + end + + def self.extract_title_and_url(item) + data = item.to_liquid + [ data['title'], data['url'] ] + end + + attr_reader :title, :url, :date, :categories, :body, :collection + + def initialize(title, url, date, categories, body, collection) + @title, @url, @date, @categories, @body, @collection = title, url, date, categories, body, collection + end + + def strip_index_suffix_from_url! + @url.gsub!(/index\.html$/, '') + end + + # remove anything that is in the stop words list from the text to be indexed + def strip_stopwords!(stopwords, min_length) + @body = @body.split.delete_if() do |x| + t = x.downcase.gsub(/[^a-z]/, '') + t.length < min_length || stopwords.include?(t) + end.join(' ') + end + end + end +end +module Jekyll + module LunrJsSearch + class SearchIndexFile < Jekyll::StaticFile + # Override write as the index.json index file has already been created + def write(dest) + true + end + end + end +end +module Jekyll + module LunrJsSearch + VERSION = "0.3.0" + end +end diff --git a/pages/publishing/gitcommands.md b/_drafts/doc_gitcommands.md similarity index 92% rename from pages/publishing/gitcommands.md rename to _drafts/doc_gitcommands.md index c46f467..4b9d56b 100644 --- a/pages/publishing/gitcommands.md +++ b/_drafts/doc_gitcommands.md @@ -1,6 +1,5 @@ --- title: Common Git Commands -permalink: /git_commands/ tags: [publishing] keywords: git, revision control, github, version control audience: writers, designers diff --git a/_drafts/search.html b/_drafts/search.html new file mode 100644 index 0000000..bb44166 --- /dev/null +++ b/_drafts/search.html @@ -0,0 +1,55 @@ +--- +--- + + + +

+
+

Search

+
+ +
+ + + + + {% raw %} + + {% endraw %} + + + + + +
+
\ No newline at end of file diff --git a/_drafts/use_git_to_download_theme.md b/_drafts/use_git_to_download_theme.md deleted file mode 100644 index 023105b..0000000 --- a/_drafts/use_git_to_download_theme.md +++ /dev/null @@ -1,10 +0,0 @@ - Using iTerm, create the directory where you want to install the project. I like using ~[username]/projects, because ~[username] is the default directory that appears when you open iTerm on a Mac. - - ``` - cd projects - mkdir acme - cd acme - ``` - -2. Once you're inside the folder for your project (for example, acme), type `git clone https://github.com/tomjohnson1492/documentation-theme-jekyll.git .` (The ` .` means to clone the github repo into the current directory. Make sure the directory is empty before cloning the theme in there.) -3. In your new project folder, remove the .git folder, because no doubt you'll be customizing this project's content and committing it to another revision control repository. \ No newline at end of file diff --git a/_includes/alerts.html b/_includes/alerts.html index 5b065b0..c729a74 100644 --- a/_includes/alerts.html +++ b/_includes/alerts.html @@ -1,4 +1,5 @@ {% capture tip %}