Skip to content

Highlight.js improvements #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 8, 2015
Merged

Highlight.js improvements #212

merged 1 commit into from
Jun 8, 2015

Conversation

@milmazz
Copy link
Member

@milmazz milmazz commented May 21, 2015

This PR include the latest release of highlight.js (v8.6) and some improvements in the JavaScript code that allow the auto-detection to Elixir and Bash blocks.

Please note that the original file elixir.css was renamed to github.css to keep the same name as the source (taken from highlight.js) and the few changes (background and border of the <pre> tags) were implemented on highlight-custom.css. This change will facilite to keep track of the github.css changes.

Last but not least, this PR is based on the ideas discussed on #150 by @dignifiedquire

@josevalim
Copy link
Member

josevalim commented May 21, 2015

I want to avoid generating many assets. Can we add the .hljs to the existing style.css with a comment and keep the github.css one as elixir.css? The reason is that github.css is not very clear as a name while elixir.css is. :) Thank you!

@eksperimental
Copy link
Contributor

eksperimental commented May 21, 2015

I cannot look at this commit now, but i would discourage the use of the autodetec ion feature.of highlight.js, as we have done in the past and it does a poor job a detcting (probably too hard of a job to solve), so that would recommend this rule, resolve to elixir unless otherwise specified in the code block

@dignifiedquire
Copy link
Contributor

dignifiedquire commented May 21, 2015

resolve to elixir unless otherwise specified in the code block

The problem with that is that you can only specify the language if you enable fenced code blocks, which @josevalim doesn't want

@ericmj
Copy link
Member

ericmj commented May 21, 2015

I want to confirm that we cannot use autodetect, it brings a lot more issues than the benefits.

@milmazz
Copy link
Member Author

milmazz commented May 27, 2015

@ericmj Have you confirmed that we cannot use the auto-detection feature from highlight.js?

After #211, which offer support for fenced code blocks, can we assume that the auto-detection feature from highlight.js is not require in our case?

It's easy to disable this feature:

// Setup Highlight.js
hljs.configure({
  tabReplace: '    ', // 4 spaces
  languages: [] // disable auto-detect
});

What do you think? /cc @josevalim @dignifiedquire

@josevalim
Copy link
Member

josevalim commented May 27, 2015

Yes, we are definitely not using autodetect from highlight.js even more now with upcoming support for fenced blocks.

@milmazz
Copy link
Member Author

milmazz commented May 27, 2015

@josevalim Wow, that was fast! working on it! 👍

@milmazz
Update highlight to v8.6
da5e5a0 
Disable auto-detect feature from highlight.js
@dignifiedquire
Copy link
Contributor

dignifiedquire commented May 27, 2015

sounds good to me :)

@milmazz
Copy link
Member Author

milmazz commented Jun 2, 2015

@ericmj @josevalim Do I need to do something else to complete this Pull Request? are you too busy right now to review this?

I'm not in a hurry, I'm just curious, that's all! 👍

@ericmj
Copy link
Member

ericmj commented Jun 2, 2015

LGTM. @josevalim we can merge and check the nightly docs build.

milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 3, 2015
@milmazz
WIP: Frameless docs + New Menu
0b258a0 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests after delete `list_item` and `list_item_template`
 - [ ] Move `js/main.js` into `app.js`
 - [ ] Review the changes made to the CSS styles.
 - [ ] Fix the index.html to avoid the frameset.
 - [ ] Improve the section below the `aside` element in `module_template`
 - [ ] Generate valid JSON for `sidebar_items.js`
 - [ ] Fix the possible conflict after elixir-lang#212 gets merged

This effort will try to fix the issue elixir-lang#175
@milmazz
Copy link
Member Author

milmazz commented Jun 4, 2015

@josevalim Ping.

milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 6, 2015
@milmazz
WIP: Frameless docs + New Menu
185d12f 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests after delete `list_item` and `list_item_template`
 - [x] Move `js/main.js` into `app.js`
 - [ ] Review the changes made to the CSS styles.
 - [ ] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [ ] Generate valid JSON for `sidebar_items.js`
 - [ ] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 6, 2015
@milmazz
WIP: Frameless docs + New Menu
1ffbc36 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests after delete `list_item` and `list_item_template`
 - [x] Move `js/main.js` into `app.js`
 - [ ] Review the changes made to the CSS styles.
 - [ ] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [ ] Generate valid JSON for `sidebar_items.js`
 - [ ] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 8, 2015
@milmazz
WIP: Frameless docs + New Menu
536ac4d 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests
 - [ ] Review the changes made to the CSS styles
 - [ ] Review the breadcrumbs
 - [ ] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
@milmazz milmazz mentioned this pull request Jun 8, 2015
Merged
18 tasks
josevalim added a commit that referenced this pull request Jun 8, 2015
@josevalim
Merge pull request #212 from milmazz/highlightjs
64b65e3 
Highlight.js improvements
@josevalim josevalim merged commit 64b65e3 into elixir-lang:master Jun 8, 2015
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 9, 2015
@milmazz
WIP: Frameless docs + New Menu
701ef5d 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests
 - [ ] Review the changes made to the CSS styles
 - [ ] Review the breadcrumbs
 - [x] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 9, 2015
@milmazz
WIP: Frameless docs + New Menu
04450b8 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [ ] Fix tests
 - [x] Review the changes made to the CSS styles
 - [x] Review the breadcrumbs
 - [x] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 10, 2015
@milmazz
WIP: Frameless docs + New Menu
745fa62 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [x] Fix tests
 - [x] Review the changes made to the CSS styles
 - [x] Review the breadcrumbs
 - [x] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 10, 2015
@milmazz
WIP: Frameless docs + New Menu
9e8ba4e 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [x] Fix tests
 - [x] Review the changes made to the CSS styles
 - [x] Review the breadcrumbs
 - [x] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 10, 2015
@milmazz
WIP: Frameless docs + New Menu
3f7d9aa 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [x] Fix tests
 - [x] Review the changes made to the CSS styles
 - [x] Review the breadcrumbs
 - [x] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4
 - [x] Avoid code duplication in some templates

This effort will try to fix the issue elixir-lang#175
@milmazz milmazz deleted the highlightjs branch June 10, 2015 23:04
milmazz added a commit to milmazz/ex_doc that referenced this pull request Jun 18, 2015
@milmazz
WIP: Frameless docs + New Menu
1aa5d1f 
This is a Work in Process, there are a lot of things to fix at this
point:

 - [x] Fix tests
 - [x] Review the changes made to the CSS styles
 - [x] Review the breadcrumbs
 - [x] Fix the possible conflict after elixir-lang#212 gets merged
 - [x] Fix the index.html to avoid the frameset.
 - [x] Improve the section below the `#sidebar` section in `module_template`
 - [x] Generate valid JSON for `sidebar_items.js`
 - [x] Improve CSS integration
 - [x] Remove frames
 - [x] Add an initial media query for `print` media
 - [x] Improve the JS style code and documentation
 - [x] Add meta tags `x-ua-compatible`, `viewport` and `generator`
 - [x] Delete `target` parameter from a element
 - [x] Add normalize.css
 - [x] Merge old full_list.css with style.css
 - [x] Add sidebar template
 - [x] Merge full_list.js into app.js
 - [x] Update jQuery v2.1.4

This effort will try to fix the issue elixir-lang#175
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@milmazz @josevalim @eksperimental @dignifiedquire @ericmj