Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Yeoman's wiki added as a submodule #28

Closed
wants to merge 3 commits into from

4 participants

@zenorocha

Now you can include any part of Wiki into a page, just like I did on faq.html.
Also moved the content from faq.md to a FAQ page on Yeoman's wiki.

@paulirish
Owner

per our IRC conversation you're going to add a few more commits?

@zenorocha

Yeah, but I figured out that are some syntax problems in markdown files, so I trying to fix them before.

@zenorocha

Actually, the problem is deeper than that.

All documentation written in markdown under yeoman/docs use these {% highlight %} tags to define a syntax highlight. For example, docs/installation.md:

{% highlight sh %}
$ curl -L get.yeoman.io | bash
{% endhighlight %}`

While all documentation written in markdown under Yeoman's Wiki use GitHub-Flavoured Markdown. For example, Additional-FAQ:

```sh
npm install -g yeoman
```'

So when we try to include some file from Wiki that doesn't have any code, it works fine. For example, FAQ. But if you include some file that does have code, for example Additional-FAQ, it doesn't work.

@ericduran
Collaborator

Yes, this is the reason why we had to change from GitHub Flavored Markdown (GFM) to use the {% highlight %}.

GFM doesn't work on Github pages. Weird I know.

@sindresorhus
Owner

It's because of this: jekyll/jekyll#619 ... When that finally lands sometime in the far future and GitHub updates we might get to use it. Until then, any ideas?

@zenorocha

That's why I prefer DocPad, Jekyll is awesome, but it's abandoned =/

@sindresorhus
Owner

Maybe we can do the syntax highlighting in JS?

Search for

```lang ```

and replace with <code data-lang="lang"> or something and use a syntax highlighting plugin.

It could actually be a very useful plugin for anyone wanting to do the same as us.

@sindresorhus

jekyll/jekyll#619 just landed, but will probably take some time before it's available in GitHub Pages.

Would anyone be interested in doing the suggested workaround above?

@zenorocha

I'm very busy now =/

@ericduran
Collaborator

That's nice timing.

@ericduran
Collaborator

@zenorocha let me know if you don't have time to finish this later. I'll can take it up after I'm done with wrapping the fork-it issues.

@zenorocha

Unfortunately I have a product to launch this month, so it's going to be hard to spend time here. Sorry about that.

@ericduran
Collaborator

@zenorocha good luck with the launch :)

I'll take this on if I have spare time through the day.

@zenorocha

Thank you @ericduran =]

@ericduran
Collaborator

@sindresorhus I was holding off, to see how far the redesign was going to go.

But I see that's not top priority right now so I'll see if I can close these open issues :)

@sindresorhus

:)

@ericduran
Collaborator

I can't add to someone else pull request so I just made another one over at #37

I also updated any docs that had issues. :)

@ericduran
Collaborator

Because the other pull request wraps this up, I'm going to close this issue.

@ericduran ericduran closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 12 additions and 69 deletions.
  1. +3 −0  .gitmodules
  2. +1 −0  _includes/yeoman.wiki
  3. +8 −0 faq.html
  4. +0 −69 faq.md
View
3  .gitmodules
@@ -1,3 +1,6 @@
[submodule "_includes/yeoman"]
path = _includes/yeoman
url = git://github.com/yeoman/yeoman.git
+[submodule "_includes/yeoman.wiki"]
+ path = _includes/yeoman.wiki
+ url = https://github.com/yeoman/yeoman.wiki
1  _includes/yeoman.wiki
@@ -0,0 +1 @@
+Subproject commit 7c1141dc801a76cffd63a2d1dc946fcb3d52cc0c
View
8 faq.html
@@ -0,0 +1,8 @@
+---
+layout: default
+markdown: 1
+---
+
+{% include yeoman.wiki/FAQ.md %}
+
+<img src="assets/img/yeoman-009.png" class="character"/>
View
69 faq.md
@@ -1,69 +0,0 @@
----
-layout: default
----
-
-# FREQUENTLY ASKED QUESTIONS
-
-
-### What are the goals of the project?
-
-The short-term goals for Yeoman are to provide developers with an improved tooling workflow so that they can spend less time on process and more time focusing on building beautiful web applications. Initially, we hope to make it as easy as possible to work with existing frameworks and tools developers are used to using.
-
-Long-term, the project may also assist developers with creating applications using modern technologies such as Web Components.
-
-### What is a command-line interface?
-
-A command-line interface is a means for developers to interact with a system using text commands. On OSX this this is often done using the Terminal and on Windows we use the command shell or a third-party tool such as [Cygwin](http://www.cygwin.com).
-
-
-### What is a package manager?
-
-A package manager runs through a command-line interface and is a tool for automating the process of installing, upgrading, configuring and managing dependencies for projects. An example of a package management registry is NPM.
-
-
-### How does Yeoman differ from Grunt?
-
-Yeoman builds upon a number of open-source tools to offer an opinionated workflow that helps developers achieve common tasks more easily.[Grunt.js](http://gruntjs.com) is one of these tools and powers our underlying build process and task plugin architecture.
-
-On top of this architecture, we've highly customized tasks, profiles and systems which work well together and also provide developers with features like our generator system and Twitter Bower integration. Yeoman takes care of configuring your Gruntfile and setup to support Sass, CoffeeScript and Require.js/r.js out of the box. With additional features like wiring, an improved `server` and `init`, we like to think of ourselves as a helper project on top of Grunt.
-
-Developers are free to continue using any Grunt tasks with Yeoman and there should remain a good level of cross-tool task compatibility.
-
-### How does Yeoman differ from tools like Brunch or BBB?
-
-We love tools like Brunch and Grunt-BBB and feel that they offer a great solution for developers wishing to scaffold with frameworks like Backbone.js and Ember. With the Yeoman generator system, as we've ported over the Rails Generator system to work with Node, we feel we have an interesting opportunity to take application scaffolding in a new direction - one where it's easier for any developer to write scaffolds, support multiple testing frameworks, capture their own boilerplates and easily re-use them and so on.
-
-### How do I register or unregister a package on Bower?
-
-Packages can be registered on Bower using the `register` command. e.g `bower register myawesomepackagename git://github.com/youraccount/yourrepo`. We recommend reading the Bower [documentation](https://github.com/twitter/bower) before doing this to ensure that your repo includes the necessary files to supporting being `install`ed.
-
-
-
-### Will the project be providing Generators for popular frameworks?
-
-Our goal is to facilitate both developers and the community with the tools needed to create rich web applications easily. With that goal in mind, we'll be providing a great API (and docs) to our Generators system with examples of how to implement samples, but will rely on the community to create and maintain Generators for popular frameworks. This will allow us to focus on making Yeoman better without he distractions of maintaining a large number of Generators.
-
-
-### What license is Yeoman released under?
-
-Yeoman is released under a [BSD](http://opensource.org/licenses/bsd-license.php/) license.
-
-### What should I do before submitting an issue through GitHub?
-
-Thanks for your interest in submitting an issue. In order for us to help you please check that you've completed the following steps:
-
-* Made sure you're on the latest version
-* Read our documentation and [README](https://github.com/yeoman/yeoman/blob/master/readme.md) to ensure the issue hasn't been noted or solved already
-* Used the search feature to ensure that the bug hasn't been reported before
-* Included as much information about the bug as possible, including any output you've received, what OS and version you're on.
-* Shared the output from `echo $PATH $NODE_PATH` and `brew doctor` as this can also help track down the issue.
-
-Issues can be submitted via the [issues tab](https://github.com/yeoman/yeoman/issues) on our GitHub repo.
-
-### My question isn't answered! Help?
-
-A few more common questions relating to using Yeoman are answered here: [github.com/yeoman/yeoman/wiki/Additional-FAQ](https://github.com/yeoman/yeoman/wiki/Additional-FAQ)
-
-<img src="assets/img/yeoman-009.png" class="character"/>
-
-
Something went wrong with that request. Please try again.