Pelican Reviews

JSDoc Reviews

Pelican mentions (25)

• Ask HN: Best way for a Markdown based blog and eBook?

  Most static site generators will work to create a blog. I use pelican [1], which serves my needs. You will likely need to edit your blogposts a little bit before putting them in the book. So I recommend a separate program for that altogether. [1] https://getpelican.com/. - Source: Hacker News / 10 days ago

• Patterns for Personal Web Sites

  In my experience, [Pelican](https://getpelican.com/) does a good job of allowing you to edit themes on all pages at once with its static page generator. There are a lot of built in features designed more for blog-like websites, but I’ve found it pretty easy to make my personal website with it. - Source: Hacker News / 7 months ago

• How to host final project (flask web application) on permanent server?

  There's also Pelican but I haven't used it and seeing as Github serves static pages I'd imagine it builds and deploys your page and is done with it. Source: about 1 year ago

• Ask HN: Which Python or Rust-based static site generators to use as of 2023?

  I use Pelican (https://getpelican.com/) for my blog, which works decently for me. It is a static site generator written in Python. But you probably won't learn much Python by using it (or Rust when using a generator written in it) since you probably won't need to change anything in it. - Source: Hacker News / about 1 year ago

• Creating a Python Wiki application

  Surely a "local private wiki ... Not web based ... On a desktop application" is not really a "wiki" at all, but rather a "static site generator" with a built-in "search". If that's what you want, there's a Python app called Pelican. Writing such an app from scratch isn't really a beginners project. Source: about 1 year ago

JSDoc mentions (51)

• How to document your JavaScript package

  Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best... - Source: dev.to / 10 days ago

• Deep Dive: Google Apps Script - Testing APIs and Automating Sheets

  Note: For simplicity, I will omit the JavaScript documentation, but for a production grade code you may want to add the documentation (see jsdoc.app website for more). - Source: dev.to / 12 days ago

• Figma's Journey to TypeScript

  You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead. It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are. Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript. [1] https://jsdoc.app/. - Source: Hacker News / 24 days ago

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / 3 months ago

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 3 months ago