HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

making updates for github 3.0

Browse Source
This commit is contained in:
Tom Johnson
2016-02-04 16:30:33 -08:00
parent 6a21ac0b7c
commit 60d94267ee
11 changed files with 45 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Gemfile
View File

@ -2,7 +2,3 @@ source 'https://rubygems.org'
#gem 'github-pages'
gem 'jekyll', '~> 2.5.3'
group :jekyll_plugins do
gem 'algoliasearch-jekyll', '~> 0.5.3'
end

9
_config.yml
View File

@ -24,6 +24,8 @@ pdf_file_name: mydoc_designers_pdf.pdf
gems:
- algoliasearch-jekyll
# the algolia entries here are experimental only.
algolia:
application_id: 'HXUBJERYYB'
index_name: 'documentation_theme_jekyll_designers'
@ -39,12 +41,7 @@ exclude:
host: 127.0.0.1
feedback_email: tomjohnson1492@gmail.com
markdown: redcarpet
redcarpet:
extensions: ["no_intra_emphasis", "fenced_code_blocks", "tables", "with_toc_data"]
highlighter: pygments
highlighter: rouge
collections:
tooltips:

2
_includes/search.html → _includes/algolia.html
View File

@ -1,3 +1,5 @@
<!-- this is an experimental of algolia search -->
<div class="search">
<input type="text" placeholder="search...">

36
_includes/topnav.html
View File

@ -71,26 +71,26 @@
{% include feedback.html %}
<!--<li>-->
<li>
<!--start search-->
<!--<div id="search-demo-container">-->
<!--<input type="text" id="search-input" placeholder="{{site.data.strings.search_placeholder_text}}">-->
<!--<ul id="results-container"></ul>-->
<!--</div>-->
<!--<script src="../js/jekyll-search.js" type="text/javascript"></script>-->
<!--<script type="text/javascript">-->
<!--SimpleJekyllSearch.init({-->
<!--searchInput: document.getElementById('search-input'),-->
<!--resultsContainer: document.getElementById('results-container'),-->
<!--dataSource: '../search.json',-->
<!--searchResultTemplate: '<li><a href="{url}" title="{{page.title | replace: "'", "\"}}">{title}</a></li>',-->
<!--noResultsText: '{{site.data.strings.search_no_results_text}}',-->
<!--limit: 10,-->
<!--fuzzy: true,-->
<!--})-->
<!--</script>-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="{{site.data.strings.search_placeholder_text}}">
<ul id="results-container"></ul>
</div>
<script src="../js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: '../search.json',
searchResultTemplate: '<li><a href="{url}" title="{{page.title | replace: "'", "\"}}">{title}</a></li>',
noResultsText: '{{site.data.strings.search_no_results_text}}',
limit: 10,
fuzzy: true,
})
</script>
<!--end search-->
<!--</li>-->
</li>
{% comment %}
{% include frameescape.html %}
{% endcomment %}

2
_layouts/default.html
View File

@ -39,7 +39,7 @@
<!-- Content Column -->
<div class="col-md-9">
<!--{% include search.html %}-->
<!--{% include algolia.html %}-->
{{content}}
</div><!-- /.row -->

3
_layouts/page.html
View File

@ -15,9 +15,8 @@ layout: default
{% if site.github_editme_path %}
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{{page.url | replace: '.html', '.md'}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{% unless page.url contains "html" %}{{page.url | replace: '.html', '.md'}}{% endunless %}{% if page.url contains "html" %}{{page.url }}{% endif %}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
{% endif %}
{{content}}
<div class="tags">

2
_layouts/page_search.html
View File

@ -8,7 +8,7 @@ layout: default
<div class="post-content">
{% include search.html %}
{% include algolia.html %}
</div>

2
configs/mydoc/config_designers.yml
View File

@ -12,7 +12,7 @@ site_title: Jekyll theme for designers
project_folder: mydoc
company_name: Your company
footer_image_location: ../common_images/company_logo.png
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/docreviews
disqus_shortname: idrbwjekyll
# variables

2
configs/mydoc/config_writers.yml
View File

@ -12,7 +12,7 @@ site_title: Jekyll theme for writers
project_folder: mydoc
company_name: Your company
footer_image_location: ../common_images/company_logo.png
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/reviews
github_editme_path: tomjohnson1492/documentation-theme-jekyll/edit/docreviews
disqus_shortname: idrbwjekyll
# variables

9
mydoc/mydoc_adding_new_projects.md
View File

@ -7,7 +7,6 @@ summary: "You add a new project essentially by duplicating all the mydoc project
series: "Getting Started"
weight: 2
---
<!-- your frontmatter goes here -->
{% include custom/mydoc/getting_started_series.html %}
@ -34,13 +33,15 @@ In the configs folder, copy the mydoc folder and its contents. Rename it to acme
In this theme, each output requires a separate config file. If you have 10 audiences and you want separate sites for each, then then you'll have 10 config files in this directory.
Change the file names from config_writers.yml and so forth to whatever file names best represent the audiences for your outputs.
More details about customizing the settings in the configuration files will be explained later. For now you're just duplicating the necessary project files for your new project.
### 3. Create a new folder inside \_includes
### 3. Create a new folder inside \_includes/custom
In the _includes/custom directory, add a new folder there called "acme." This folder should sit parallel to the mydoc folder. This is where you can store includes for your project.
### 4. Add an acme folder in the root directory
### 4. Add a new folder in the root directory
In the root directory, add a folder for your pages called acme (similar to the mydoc folder). Include two subfolders inside acme: files and images.
@ -52,7 +53,7 @@ Note that you cannot create subfolders in this acme directory. All of your pages
### 5. Copy and customize the mydoc shell scripts in the root directory
In the root directory, duplicate the shell scripts and rename the prefix to "acme_". The following files are the shell scripts that need to be duplicated:
In the root directory, duplicate the shell scripts (the file extension is .sh) and rename the prefix to "acme_". The following files are the shell scripts that need to be duplicated:
* mydoc_1_multiserve_pdf.sh
* mydoc_2_multibuild_pdf.sh

12
mydoc/mydoc_configuration_settings.md
View File

@ -15,6 +15,18 @@ The configuration file serves important functions with single sourcing. For each
The configuration file contains most of the settings and other details unique to that site output, such as variables, titles, output directories, build folders, and more.
## Change the project name within the config file
By default, the config file contains the project name, such as mydoc, in numerous places. You can do a find and replace in each of the configuration files to replace "mydoc" with your new project's name. You can also fine tune the configuration settings by looking at what each of them does (as described in the following sections).
## Update the exclude list
By default, all the files in the Jekyll project are included in the output. You have two manually tell Jekyll which files and folders you want to exclude from the output. In each configuration file there is an `exclude` property that takes a list of items that should be excluded from the build.
In the new configuration file that you created, exclude the mydoc folder and any other mydoc files that you don't want to be output. Similarly, update the mydoc configuration files to exclude the new project that you added.
Manually excluding files from the output is one of pain points in Jekyll that I could never solve. Jekyll was not designed for multiple output publishing but was conceived as a way to manage files for a single website.
## Configuration file variables
You can define arbitrary key-value pairs in the configuration file, and then you can access them through `site.yourkey`, where `yourkey` is the name of the key.