Skip to content
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.

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

[Question] One page theme #109

Open
Kikobeats opened this issue Jun 20, 2016 · 7 comments
Open

[Question] One page theme #109

Kikobeats opened this issue Jun 20, 2016 · 7 comments

Comments

@Kikobeats
Copy link
Contributor

I'm interested in create a docpress theme called docpress-one that presents all the documentation in one html file.

Something very inspired on this: http://apex.run/

Do you think that could be more or less easy to do?

@rstacruz
Copy link
Contributor

It sounds possible. Not super easy, but possible.

Docpress is simply two Metalsmith plugins:

  • docpress-core (parses your MD and turns them into basic html)
  • docpress-Base (adds CSS, js, etc onto those htmls)

What you need to do is reimplement docpress-Base yourself. Make it a
Metalsmith plugin that consolidates those HTML files into one. Lemme know
how I can help!

On Mon, Jun 20, 2016, 6:28 PM Kiko Beats notifications@github.com wrote:

I'm interested in create a docpress theme called docpress-one that
presents all the documentation in one html file.

Something very inspired on this: http://apex.run/

Do you think that could be more or less easy to do?


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#109, or mute the thread
https://github.com/notifications/unsubscribe/AAEikUwBxxl4UpFga8tgPoPV4rKE9QUHks5qNmtVgaJpZM4I5kJG
.

@Kikobeats
Copy link
Contributor Author

👍 let's do it

@Kikobeats
Copy link
Contributor Author

Another inspirational website: https://github.com/lerna/website

@Kikobeats Kikobeats reopened this Jun 21, 2016
@Kikobeats
Copy link
Contributor Author

I think that the point is the relayout function: https://github.com/docpress/docpress-base/blob/master/index.js#L149

Basically in the function you are creating a html file based in the metadata and using the jade layout.

The thing that I want to do is do the same but append into the index file. It is correct?

@Kikobeats
Copy link
Contributor Author

I tried do something fast as proof concept. Basically reimplement relayout method to append all the html into the index file:

https://gist.github.com/Kikobeats/a04f88212d462c2d19abe8544bfafa96

I need to reorganize the aside to works with the new markup. What do you think?

@Kikobeats
Copy link
Contributor Author

expected output similar to: http://astrum.nodividestudio.com/pattern-library/

knownasilya pushed a commit that referenced this issue Aug 29, 2016
knownasilya pushed a commit that referenced this issue Aug 29, 2016
* Use sectionTitle for prev/next titles

Goes with the changes over at docpress/docpress-core#107
so don't merge unless that PR is merged.

* Rename section title to pageTitle

See #109
@rstacruz
Copy link
Contributor

I think it's possible to implement this as a plugin that's to be included after docpress-base. With the recent talks on theming, I think a one-page style should be part of the official themes.

Here's a quick and dirty demo:

docpress-theme

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants