pugjs / pug-en Goto Github PK

Hi,

I did not understand what does mean "with attributes" regarding to buffered code?

https://github.com/pugjs/pug-en/blob/master/src/language/code.md#buffered-code

It can also be written inline with attributes, and supports the full range of JavaScript expressions:

I was asking myself if it could be a mistake since I do not see any attributes in the example.

Thanks,

The outputs of the examples in the filters page are broken because the :markdown-it filter is not known:

index.pug:1:1

unknown filter ":markdown-it"

See also: pugjs/pug#3249

It would be nice to add a link to the source repository (https://github.com/pugjs/pug-en) of the documentation on the footer of the website or on the navbar.
Another option is to add an "Edit" button on each page leading the corresponding source file, eg. https://github.com/pugjs/pug-en/blob/master/src/language/attributes.md

I'm pretty sure that something should be displayed on that right panel. The path is https://pugjs.org/language/filters.html, under Nested Filters.

(In case it's a browser problem, I'm on Chrome on Debian, latest version).

The example in pug.compileClient is wrong:

var pug = require('pug');

// Compile a function
var fn = pug.compileClient('string of pug', options);

// Render the function
var html = fn(locals);
// => 'function template(locals) { return "<string>of pug</string>"; }'

pug.compileClient return a string. fn is not a callable function, except we eval it.

Additional Comments

It is not clear for people that land from google what pug is.

You should create a page with a content similar to the README.md of https://github.com/pugjs/pug explaining what put is and what it can do.

I would like to add the plugin docs, per pugjs/pug#3211. I didn't even know that the sub packages could have their own plugins, maybe the first comment in that issue is mistaken on that point. My plan is to document all usages of this function (and maybe others if I find them), and write a very minimal description of the arguments they take. If i can figure it out, also what they are supposed to do. I will try to add this as a top level right-hand-side menu item in strings.json.

Please give me some feedback on this plan before next month when i will plan on starting this process.

Thanks for maintaining a favorite nodejs module of mine.

Is there any way we could get a page for optimizing pug projects? Any gotchas that we need to be aware of, or ways that we can make sure that our apps scale?

pugjs.com refused to connect.

Just a heads up.

https://github.com/pugjs/pug-en/blob/master/src/language/inheritance.md

In Pug v1, if no file extension is given, .pug is automatically appended to the path, but in Pug v2 this is behavior is deprecated.

https://github.com/pugjs/pug-en/blob/master/src/language/includes.md

In Pug v1, if no file extension is given, .pug is automatically appended to the file name, but in Pug v2 this is behavior is removed.

Are they behave differently? or is a typo?

(master is at efc8d8f, now)

The docs for Pug are very nice in showing the pug and html code side-by-side.

How can one contribute to improving the docs? The PRs with proposed changes and improvements appear to be ignored.

It would be nice to have a search bar on the documentation.

When quickly scanning the docs, some (including me) can spot the old syntax in the docs (a(href="/#{url}") Link) which was removed in 2.0 and without reading the text around it (which says it was removed), they can go and use it.

I propose removing this information from this page of the docs, maybe with link "There used to be some other syntax, see migration guide for more information".
I think that the information about usage of template strings and other ways of attr interpolation should not be removed.