Skip to content
This repository was archived by the owner on Dec 24, 2018. It is now read-only.

Commit bc1647c

Browse files
committed
final commit.
this repo has been merged into sparklemotion/nokogiri.org
1 parent 2aa2486 commit bc1647c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2
-1607
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

Gemfile

Lines changed: 0 additions & 5 deletions
This file was deleted.

LICENSE

Lines changed: 0 additions & 26 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,4 @@
11

2-
# The Official Tutorial Archive™ of Nokogiri®
2+
__The source materials for [Nokogiri](https://github.com/sparklemotion/nokogiri) docs appearing at https://nokogiri.org/ has been moved to https://github.com/sparklemotion/nokogiri.org/__
33

4-
These tutorials appear on [nokogiri.org](http://nokogiri.org/) at
5-
[http://nokogiri.org/tutorials](http://nokogiri.org/tutorials).
6-
7-
8-
## How Do I Suggest Opportunities for Improving Documentation?
9-
10-
You could start by emailing
11-
[nokogiri-talk](http://groups.google.com/group/nokogiri-talk).
12-
13-
Or, if you're feeling antisocial, you could just open a [Github
14-
Issue](https://github.com/sparklemotion/nokogiri.org-tutorials/issues).
15-
16-
17-
## What needs to be documented? I'd like to help.
18-
19-
Take a look at the [open issues](https://github.com/sparklemotion/nokogiri.org-tutorials/issues)!
20-
21-
22-
## How Do I Contribute Documentation?
23-
24-
1. Fork.
25-
2. Edit.
26-
3. Submit pull request.
27-
28-
Please mentally prepare to have your contributions copyedited. Edits
29-
don't mean you're a bad writer, it means that we want the
30-
documentation to have a ["Unity of
31-
Effect"](http://en.wikipedia.org/wiki/The_Philosophy_of_Composition).
32-
33-
34-
## How Do I Edit and View My Changes?
35-
36-
I've built an overly-complicated system that runs the ruby code in the
37-
documentation and captures the output as part of the final
38-
product. (See "Inline Code" below.)
39-
40-
So, you write markdown and the Rakefile generates better markdown.
41-
42-
1. `bundle install`
43-
2. Edit markdown files in the `content/` directory.
44-
3. `bundle exec rake markdown`
45-
4. View final versions of markdown in the `markdown/` directory.
46-
47-
If you want to see how your docs would appear on nokogiri.org, you
48-
should clone the repository at
49-
[github.com/sparklemotion/nokogiri.org](https://github.com/sparklemotion/nokogiri.org)
50-
and follow the instructions there. This repository is a submodule of
51-
that one.
52-
53-
54-
### Inline Code
55-
56-
Lines starting with `~~~ inline <filename>` are replaced by the file contents in a blockquote.
57-
58-
It's recommended to place anything that's not text into a separate
59-
asset file (so my [bitchin' editor](http://www.gnu.org/software/emacs/)
60-
can use the right mode).
61-
62-
So, if you want to inline any blockquoted content, create a file in
63-
`content/assets` and reference it from the markdown file like so:
64-
65-
Here's some XML for your entertainment:
66-
67-
~~~ inline assets/shows.xml
68-
69-
And here's some ruby:
70-
71-
~~~ inline assets/search-setup.rb
72-
73-
74-
### Live Code with `xmpfilter`
75-
76-
In many places in the docs, ruby code is presented along with its
77-
output
78-
([like here](http://nokogiri.org/tutorials/searching_a_xml_html_document.html)).
79-
80-
When the docs are generated, this ruby code is actually run with the
81-
installed version of nokogiri, and the output is captured! Wicked
82-
awesome! How does that work?
83-
84-
Lines starting with `~~~ ruby <filename>` are replaced by the output
85-
of running the code in `<filename>` through
86-
[xmpfilter](http://eigenclass.org/hiki.rb?xmpfilter).
87-
88-
So, if you want to inline ruby code and its output, create a file in
89-
`content/assets` and reference it from the markdown file like so:
90-
91-
Here's some ruby along with its stdout:
92-
93-
~~~ ruby assets/search-xpath-characters-first.rb
94-
95-
96-
### Adding New Chapters
97-
98-
If you want to add a new chapter, make sure you update the file
99-
`content/toc` to contain the title (the first H1) of the
100-
chapter. `toc` is an ordered list.
101-
102-
103-
### Conventions
104-
105-
Don't use inline links. Instead, use footnote-style. Any variation is OK, including blank name:
106-
107-
Check out [my lolcat][]
108-
109-
[my lolcat]: http://icanhascheezburger.com/
110-
111-
or a semantic name:
112-
113-
Check out [this picture of my lolcat][lolcat]
114-
115-
[lolcat]: http://icanhascheezburger.com/
116-
117-
or an integer:
118-
119-
Check out [this picture of my lolcat][1]
120-
121-
[1]: http://icanhascheezburger.com/
4+
This repository has been merged into [that one](https://github.com/sparklemotion/nokogiri.org/), so this repo is archived and deprecated and no longer in use.

Rakefile

Lines changed: 0 additions & 144 deletions
This file was deleted.

TODO

Lines changed: 0 additions & 22 deletions
This file was deleted.
-44.9 KB
Binary file not shown.

content/assets/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

content/assets/atom.xml

Lines changed: 0 additions & 20 deletions
This file was deleted.

content/assets/modify-change-content.rb

Lines changed: 0 additions & 7 deletions
This file was deleted.

content/assets/modify-creating-new-nodes-with-tags.rb

Lines changed: 0 additions & 8 deletions
This file was deleted.

content/assets/modify-creating-new-nodes.rb

Lines changed: 0 additions & 10 deletions
This file was deleted.

content/assets/modify-nodes-and-attrs.rb

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)