Giter Club home page Giter Club logo

docs's Introduction

CI

This is the repository for the Handlebars documentation site.

Why vuepress?

There are a lot of static page generators out there nowadays. I have chosen vuepress over other systems for several reasons:

  • I like vuejs.
  • Vuepress builds fast loading static sites with modern PWA technologies.
  • Vuepress is centered around markdown, but leaves the opportunity to inject interactive parts if needed
  • Vuepress has a simple predefined way of adapting stylesheets, which makes it easy to adapt colors from the original site without rewriting the whole css
  • The vuejs documentation site is build with vuepress, so it will hopefully be around for a while.

You can challenge me and propose other solutions, but you might be asked to help out if you do.

-- Nils

๐Ÿš€ ๐Ÿš€

docs's People

Contributors

alfhir avatar anpalmer avatar arav-agarwal2 avatar biehla avatar cvoudouris avatar dependabot[bot] avatar erisds avatar eswarijayakumar avatar et2211 avatar hannesvdvreken avatar ilharp avatar jaylinski avatar jonasgeiler avatar kennyoliver avatar mikerollins avatar myunwoo avatar nick-rivera avatar nknapp avatar nkratzmeyer avatar papasmile avatar pbmchc avatar peterhunn avatar pjbennett avatar rahmanfadhil avatar rpaterson avatar webdiscus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Add missing sections to "Precompilation page"

On https://handlebars-draft.knappi.org/topics/precompilation.html, there are some chapters missing.

The sections are marked with a "TODO" text. The contents can be compied from http://handlebarsjs.com/precompilation.html

The usage output at the top of the "Usage" section and the box following "On the client side you have Javascript along the lines of the following." should ideally be included from a file in src/usage-examples/precompilation so using the syntax

<<< @/src/usage-examples/precompilation/handlebars-usage.txt

and

<<< @/src/usage-examples/precompilation/example.precompiled.js

This would enable us to auto-generate its contents with the latest.

If you feel really good, you can try to create a vuepress-plugin that automatically creates those files using the latest version of Handlebars.

Need doc for registered Helper that uses async call

Hi,

I have a lookup table cached in Redis, [productId: string]: string
An async service that returns the productName based on productId

The context passed to the template is like:
productIds: ["1", "2"]

Template looks like:
{{#array}}{{ translate productIds }}{{/array}}

Any solution with handlebars? (Async + Handlebars + Typescript)

Technical writer wanted?

I thought, maybe in the long run we might need someone who has experience writing technical documentation. I am a software engineer, not a writer, although I like to write. But I think some of the things I write might be hard to understand. Even for the structure of the site, some opinions might be helpful.

If anybody knows somebody, that would be great.

Taking the new handlebars-site live

I am pretty excited about this, because it means one milestone in a project I have been working on during the last months:

I think the new handlebars site is now ready to go live. It may not be perfect yet, but it should contain all information from the old site. In some cases more, and it is definitely easier to use, search and play around with.

I have setup up a two stage deployment workflow. That way, changes can be previewed on master and then merged in to the production-branch via PR.

Currently, I am using the following domains:

My goal would be to move them all to

@wycats I don't have access to those domains and no full access to the handlebars-site project . What I would like you to do is:

  • Have a look if there is anything essential missing on the new page (from your point of view)
  • Set the CNAME for all three above domains to handlebars-lang.github.io
  • Move the handlebars-site project to the github.com/handlebars-lang
  • Update the fqdn property for the prod build to handlebarsjs.com and push to the production-branch.

I can do the rest myself, but the last step should ensure that handlebarsjs.com does not go down in between. It may loose SSL for some time though.

todo: site features

Please feel free to add comments, feedback, or pushback on any of these. I (or anyone with edit rights) can update this list based on feedback in the comments.

Style / layout

I have no preference regarding the style at all. Please feel free to give suggestions or point out sites that you love.

For the most part, the templates and markdown content will be relatively unaffected by the styling decisions we make. Thus, for the time being, I'm going to just implement a basic site with default theme that gives us something to visualize, then we can completely change that later when we decide on the "real" theme/design.

Areas

Just thinking out loud... feedback would be great.

  • home
  • examples / recipes
  • API / documentation
  • community (?)
  • blog (?)

Search

We can use any solution for this. If no one objects, I recommend using algolia.

getting started

continuing the discussion from handlebars-lang/handlebars.js#1345

@nknapp per your last comment, how about if we just start adding the project scaffold and build out from there?

Fwiw, I don't have any hard requirements or expectations, I just like the idea of helping out with this. We benefit from it because we use handlebars a lot, and we get a lot of handlebars questions on our projects. Improving the handlebars docs will help with that (which we're obliged to do). To that end, if there are things you want to get started on, please feel free to do that, then I'll just pull down whatever you do and join along. @doowb and I are easy going and can adapt to whatever work style we need to.

bot

I noticed that there is a bot repo here on the handlebars-lang org.

Assuming the intent was to add a bot for helping with issues, etc. Is there a bot already set up somewhere or does anyone have a preference regarding the bot we use? @doowb and I created a bot system that we use with a lot of our projects. It's been really helpful.

We don't need to use that, but if no one has a preference we can hook that up here, along with custom template and messaging, etc.

question: license, author, copyright info, etc.

I just wanted to get some feedback on these things:

  • license - same as current site, or different?
  • copyright - same as current site, or different?
  • creative commons - in addition to other applicable licenses, we usually like to add a CC BY 3.0 license for documentation. Any objections to that?
  • author(s) - I assume that myself and other contributors to the new documentation will be authors, but I also don't lose sleep over this and don't have any problem with differences of opinion on how this works. Any guidance is welcome.

(while/if I'm waiting for answers I'll just go ahead and push up what was generated by my scaffolding tool, then we can amend the information based on feedback to this issue)

cc @wycats @nknapp (not sure who else should be mentioned on this)

(edited to add CC checklist item)

Supporting `@last` for object iteration

Hi,

The doc of built-in #each has the following assertion:

When iterating over an object only the @first is available.

I believe that this assertion is not true since 2014 (this commit).

It is true that some implementation have not implemented this by default (see my ticket for .NET), but please consider updating the assertion.

Thanks,
Yehoshua

push access

It seems I can't push to this repository. It's probably related to third-party access settings on the org, if someone could look into it.

Usage snippet in installation/precompilation is broken

The snippet is empty as can be seen here (https://handlebarsjs.com/installation/precompilation.html#usage):
image

I did some tracing and found the corresponding part in the md:

!HANDLEBARS_HELP!

Which seems to be a custom syntax extension to VuePress' markdown, handled by this plugin here:

export function updateHandlebarsCliHelp() {

But the above part seems to be authored quite some time ago. So, I suspect that one or more of these things might have changed since 30f6884 and gone unnoticed:

  • The way md syntax extensions should be written
  • Path of the handlebars bin
  • The way handlebars bin should be run
  • The output when handlebars bin is run

Or maybe something else. But I'm not familiar with VuePress or tapping into md parsers, so I just wanted to report the issue and my contemplation on it ยฏ\(ใƒ„)/ยฏ Hope this helps!

New attempt

I have now made a new attempt to build a new Handlebars site.
The auto-deploy to gh-pages via travis is still missing.

Could anybody with access to the Handlebot please add the secret variable GITHUB_TOKEN to
.travis.yml so that travis can deploy to github pages?

Replace examples using `<Example examplePage=... />` by `<ExamplePart examplePage="..." / >`

Throughout the site, the <Example examplePage=... /> is used to include interactive examples.
The newer 'is more flexible and be embedded more fluently into the text. I would like to see the occurrences ofbe replaced by`.

If you are attempting to do this, please have a look at the documentation for interactive examples first. You probably need to rewrite the text around the embedded example as well. The original formulation on https://handlebarsjs.com/ can help you do that.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.