diff --git a/_data/mydoc/mydoc_sidebar.yml b/_data/mydoc/mydoc_sidebar.yml index 772eb98..8c529be 100644 --- a/_data/mydoc/mydoc_sidebar.yml +++ b/_data/mydoc/mydoc_sidebar.yml @@ -68,6 +68,7 @@ entries: version: all output: web + - title: Get started audience: writers, designers platform: all @@ -544,6 +545,14 @@ entries: version: all output: web, pdf + - title: Adding all project dependencies + url: /mydoc/mydoc_install_dependencies.html + audience: writers, designers + platform: all + product: all + version: all + output: web, pdf + - title: Tag archives audience: writers, designers platform: all diff --git a/_data/mydoc/mydoc_urls.yml b/_data/mydoc/mydoc_urls.yml index fcd02cd..c5b533d 100644 --- a/_data/mydoc/mydoc_urls.yml +++ b/_data/mydoc/mydoc_urls.yml @@ -13,6 +13,11 @@ + + + + + home: title: "Introduction" url: "../mydoc/home.html" @@ -20,27 +25,6 @@ home: -mydoc_getting_started: - title: "Getting started with this theme" - url: "../mydoc/mydoc_getting_started.html" - link: "Getting started with this theme" - - - -mydoc_configuration_settings: - title: "Setting configuration options" - url: "../mydoc/mydoc_configuration_settings.html" - link: "Setting configuration options" - - - -mydoc_adding_new_projects: - title: "Adding new projects" - url: "../mydoc/mydoc_adding_new_projects.html" - link: "Adding new projects" - - - mydoc_supported_features: title: "Supported features" url: "../mydoc/mydoc_supported_features.html" @@ -48,6 +32,92 @@ mydoc_supported_features: +mydoc_about: + title: "About the theme author" + url: "../mydoc/mydoc_about.html" + link: "About the theme author" + + + +mydoc_support: + title: "Support" + url: "../mydoc/mydoc_support.html" + link: "Support" + + + + + +mydoc_getting_started: + title: "1. Build the default project" + url: "../mydoc/mydoc_getting_started.html" + link: "1. Build the default project" + + + +mydoc_adding_new_projects: + title: "2. Add a new project" + url: "../mydoc/mydoc_adding_new_projects.html" + link: "2. Add a new project" + + + +mydoc_decide_on_attributes: + title: "3. Decide on your project's attributes" + url: "../mydoc/mydoc_decide_on_attributes.html" + link: "3. Decide on your project's attributes" + + + +mydoc_configuration_settings: + title: "4. Set the configuration options" + url: "../mydoc/mydoc_configuration_settings.html" + link: "4. Set the configuration options" + + + +mydoc_conditions_file_customization: + title: "5. Customize the conditions file" + url: "../mydoc/mydoc_conditions_file_customization.html" + link: "5. Customize the conditions file" + + + +mydoc_configure_sidebar: + title: "6. Configure the sidebar" + url: "../mydoc/mydoc_configure_sidebar.html" + link: "6. Configure the sidebar" + + + +mydoc_top_navigation: + title: "7. Configure the top navigation" + url: "../mydoc/mydoc_top_navigation.html" + link: "7. Configure the top navigation" + + + +mydoc_url_generator_customization: + title: "8. Customize the URL generator" + url: "../mydoc/mydoc_url_generator_customization.html" + link: "8. Customize the URL generator" + + + +mydoc_princexml_setup: + title: "9. Set up Prince XML" + url: "../mydoc/mydoc_princexml_setup.html" + link: "9. Set up Prince XML" + + + +mydoc_build_scripts: + title: "10. Configure the build scripts" + url: "../mydoc/mydoc_build_scripts.html" + link: "10. Configure the build scripts" + + + mydoc_pages: @@ -64,10 +134,17 @@ mydoc_webstorm_text_editor: -mydoc_series: - title: "Series" - url: "../mydoc/mydoc_series.html" - link: "Series" +mydoc_conditional_logic: + title: "Conditional logic" + url: "../mydoc/mydoc_conditional_logic.html" + link: "Conditional logic" + + + +mydoc_content_reuse: + title: "Content reuse" + url: "../mydoc/mydoc_content_reuse.html" + link: "Content reuse" @@ -87,10 +164,10 @@ mydoc_sidebar_navigation: -mydoc_top_navigation: - title: "Top navigation" - url: "../mydoc/mydoc_top_navigation.html" - link: "Top navigation" +mydoc_yaml_tutorial: + title: "YAML tutorial in the context of Jekyll" + url: "../mydoc/mydoc_yaml_tutorial.html" + link: "YAML tutorial in the context of Jekyll" @@ -101,6 +178,13 @@ mydoc_tags: +mydoc_series: + title: "Series" + url: "../mydoc/mydoc_series.html" + link: "Series" + + + mydoc_adding_tooltips: @@ -175,22 +259,6 @@ mydoc_syntax_highlighting: -mydoc_conditional_logic: - title: "Conditional logic" - url: "../mydoc/mydoc_conditional_logic.html" - link: "Conditional logic" - - - -mydoc_content_reuse: - title: "Content reuse" - url: "../mydoc/mydoc_content_reuse.html" - link: "Content reuse" - - - - - mydoc_commenting_on_files: title: "Commenting on files" url: "../mydoc/mydoc_commenting_on_files.html" @@ -221,6 +289,13 @@ mydoc_link_validation: +mydoc_title_checker: + title: "Check page title consistency" + url: "../mydoc/mydoc_title_checker.html" + link: "Check page title consistency" + + + mydoc_generating_pdfs: title: "Generating PDFs" url: "../mydoc/mydoc_generating_pdfs.html" @@ -263,6 +338,13 @@ mydoc_push_build_to_server: +mydoc_no_password_prompts_scp: + title: "Getting around the password prompts in SCP" + url: "../mydoc/mydoc_no_password_prompts_scp.html" + link: "Getting around the password prompts in SCP" + + + mydoc_kb_layout: @@ -302,6 +384,24 @@ mydoc_glossary: +mydoc_algoliasearch: + title: "Configuring Algolia search" + url: "../mydoc/mydoc_algoliasearch.html" + link: "Configuring Algolia search" + + + + + +mydoc_mercurial_collaboration: + title: "Mercurial notes and tips" + url: "../mydoc/mydoc_mercurial_collaboration.html" + link: "Mercurial notes and tips" + + + + + mydoc_troubleshooting: title: "Troubleshooting" url: "../mydoc/mydoc_troubleshooting.html" @@ -309,6 +409,13 @@ mydoc_troubleshooting: +mydoc_install_dependencies: + title: "Adding all project dependencies" + url: "../mydoc/mydoc_install_dependencies.html" + link: "Adding all project dependencies" + + + mydoc_tag_archives_overview: @@ -354,6 +461,13 @@ tag_special_layouts: link: "Special layout pages" +tag_collaboration: + title: "Collaboration pages" + url: "../mydoc/tag_collaboration.html" + link: "Collaboration pages" + + + @@ -369,17 +483,6 @@ tag_special_layouts: -/mydoc_about: - title: "About this theme" - url: "../mydoc_about.html" - link: "About this theme" - - - -/mydoc_support: - title: "Support" - url: "../mydoc_support.html" - link: "Support" diff --git a/mydoc/mydoc_getting_started.md b/mydoc/mydoc_getting_started.md index 3f66e11..ac3626b 100644 --- a/mydoc/mydoc_getting_started.md +++ b/mydoc/mydoc_getting_started.md @@ -18,6 +18,8 @@ Before you start installing the theme, make sure you have all of these prerequis * **[Rubygems](https://rubygems.org/pages/download)**. This is a package manager for Ruby. Type `which gem` to confirm. * **Text editor**: My recommendations is WebStorm (or IntelliJ). You can use another text editor. However, there are certain shortcuts and efficiencies in WebStorm (such as using Find and Replace across the project, or Markdown syntax highlighting) that I'll be noting in this documentation. +I added a page called {{site.data.mydoc.mydoc_urls.mydoc_install_dependencies.link}} that explains how to install any necessary RubyGem dependencies in case you run into errors. + ## Build the default project Before you start customizing the theme, make sure you can build the theme with the default content and settings first. diff --git a/mydoc/mydoc_install_dependencies.md b/mydoc/mydoc_install_dependencies.md new file mode 100644 index 0000000..ff897bb --- /dev/null +++ b/mydoc/mydoc_install_dependencies.md @@ -0,0 +1,92 @@ +--- +title: Adding all project dependencies +tags: [getting-started] +keywords: +summary: "" +--- + +You want to be sure that you have all the required gems and other utilities on your computer to make the project run. Jekyll runs on Ruby, and there are various plugins for Ruby that enable different functionality. These Ruby plugins are referred to as gems, and you install the gems you need for your projects. + +To manage the various gems and their versions needed for your project, you can use a package manager called Bundler. Many projects will have a gemfile in their project that lists the gems required for the project. You then run Bundler in order to automatically install the required gems and any dependencies for those gems on your machine. + + +## RubyGems + +Make sure you have RubyGems. This should be installed by default. + +Open Terminal and type `which gem`. You should get a response indicating the location of Rubygems, such as `/Users/MacBookPro/.rvm/rubies/ruby-2.2.1/bin/gem`. + +If you need to install Rubygems, see [Download RubyGems](https://rubygems.org/pages/download). + +## Install Bundler + +[Bundler](http://bundler.io/) is a package manager for RubyGems. + +You install Bundler by using the gem command with RubyGems: + +``` +gem install bundler +``` + +If you're prompted to which to superuser mode (`sudo`) to get the correct permissions to install Bundler in that directory, avoid doing this. All other applications that need to use Bundler will likely not have the needed permissions to run. + + +If you get a permissions error when trying to install Bundler, use Homebrew to install a Ruby package manager called rbenv. + +Install Homebrew: + +``` +/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" +``` + +Use brew to install rbenv: + +``` +brew install rbenv +``` + +Initialize rbenv: + +``` +rbenv init +``` + +Log out of terminal, and then then log back in. + +Install Bundler: + +``` +gem install bundler +``` + +Open the gemfile: + +``` +open gemfile +``` + +You should see some gems listed. If you don't have a gemfile, your project may not need any gems, or those gems may not be managed at the project level but rather directly installed manually. You can create a gemfile by typing `bundle init`. + +Your gemfile might look like this: + +``` +# A sample Gemfile +source "https://rubygems.org" + +# gem "rails" +gem 'github-pages' +gem 'pygments.rb' +gem 'redcarpet' +``` + +Use Bundler to install the needed gems: + +``` +bundle install +``` + +Finally, you can run the following to make sure the installed gems get associated or initialized with your project: + +``` +bundle exec jekyll serve +``` \ No newline at end of file diff --git a/mydoc/mydoc_webstorm_text_editor.md b/mydoc/mydoc_webstorm_text_editor.md index bc138c6..bb2f5dc 100644 --- a/mydoc/mydoc_webstorm_text_editor.md +++ b/mydoc/mydoc_webstorm_text_editor.md @@ -19,6 +19,11 @@ By default, WebStorm comes packaged with a lot more functionality than you proba Since you'll be writing in Markdown, having color coding and other support for Markdown is key. Install the Markdown Support plugin by going to **WebStorm > Preferences > Plugins** and clicking **Install JetBrains Plugin**. Search for **Markdown Support**. + +## Enable Soft Wraps (word wrapping) + +Most likely you'll want to enable soft wraps, which wraps lines rather than extending them out forever and requiring you to scroll horizontally to see the text. To enable softwrapping, go to **WebStorm > Preferences > Editor > General** and see the Soft Wraps section. Select the **Use soft wraps in editor** check box. + ## Learn a few key commands |Command | Shortcuts |