spectaql
mkdocs-material
spectaql | mkdocs-material | |
---|---|---|
14 | 93 | |
1,047 | 18,342 | |
1.4% | - | |
6.8 | 9.8 | |
6 days ago | 2 days ago | |
JavaScript | HTML | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
spectaql
-
What software do you use to write documentation?
I've also used spectaql before to auto generate graphql docs.
-
Best tool for creating GraphQL API documentation?
Other than that, SpectaQL is also a good tool that is well maintained.
-
Open Source Static Documentation Generator for GraphQL
Hi All, Wanted to share that we officially released v1.0 of SpectaQL
-
Introducing SpectaQL 1.0 - an even better way to autogenerate GraphQL API documentation
It gets downloaded thousands of times per week on NPM
Last year, Anvil introduced SpectaQL to the opensource community, and it's been a big success. We've seen thousands of weekly downloads and a healthy amount of user support and interest via GitHub.
-
Manipulate and query GraphQL Schemas with ease using Microfiber
A while back we introduced SpectaQL to the open source community and it's been a big success. It gets thousands of weekly downloads, has a healthy amount of user support and interest via github, and has had a number of articles written about it like this one and this one. Our goal for SpectaQL has always been to be the de-facto go-to library to use for auto-generating static HTML documentation for any GraphQL API. A very important feature of SpectaQL is its ability to "hide" any parts of your API that you don't want to expose in your documentation. This sounds like a simple task, but in practice it's actually a bit tricky. In order to make interacting and manipulating a GraphQL schema easy, we developed a tool designed specifically for this purpose. Eventually we realized that while this tool was super integral to SpectaQL, it would also be useful for other applications so we decided to break it out into its own library and open source it! In this post, I'll introduce Microfiber and give an overview of its most interesting features and capabilities.
-
Creating Static Documentation For GraphQL APIs Using GraphQL SDL
For this, we'll be using a library called SpectaQL, which is based on the popular library Spectacle that works with Open API and Swagger specifications. SpectaQL can be installed globally on your machine from npm:
-
Keeping certain parts of your GraphQL schema hidden from Introspection
GraphQL is a popular and powerful way to build your APIs and power your website; we use it for most of our APIs at Anvil. One of the best things about GraphQL is that it provides an Introspection Query capability which allows users to explore and learn about what's possible in a given API. In that way, GraphQL is "self-documenting". Some great tools like Playground and Anvil's own SpectaQL leverage the Introspection Query.
-
SpectaQL - generate static docs for a GraphQL schema
Source: github.com/anvilco/spectaql
-
Good Graphql Documentation
I haven't tried it myself, but I recently heard about SpectaQL and it seems worth a look.
mkdocs-material
-
🚚 Building MVPs You Won’t Hate
Material Mk-Docs by Martin Donath works well if you prefer python.
-
The Open Source Sustainability Crisis
https://squidfunk.github.io/mkdocs-material/
I'm an 'outsider', but from from the outside the Material For MkDocs Project looks like a very well managed open source project.
Martin Donath's project uses a 'sponsorware' release strategy to generate donations.
From my vantage point it seems to be working pretty well.
- Release Mkdocs-Material-9.5.0
- Agora a nossa Megathread possui um novo visual!
-
Ask HN: What's the best place to start a newsletter?
I just recently went through this decision process. My aim is to write code and math oriented posts so I need good support for nice syntax highlighting (at least colored) and mathjax (preferable) or katex. Substack is the most popular newsletter platform but fails at these two criteria. I love how math and syntax highlighting (plus numerous other features) work in MkDocs Material, which recently added a Blog plugin.
I wanted to combine the best of both: Substack as an amazing email social network, and MkDocs Material’s awesome look. So I’ve gone with using Substack as the core platform which I use to manage subscribers, and use it to post either math/code-free posts or a short teasers pointing to my main blog site on MkDocs Material when I need to show math/code
https://squidfunk.github.io/mkdocs-material/
- Material for MkDocs – Documentation that simply works
- Features tied to 'Piri Piri' funding goal
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Changing CMS from Wordpress to ?
I've been migrating content to MKDocs (Material) over the last few months, so feel fairly qualified on this subject. It's somewhat limited in terms of navigation, but can probably handle 400-500 pages; you can see how navigation works in the link. Otherwise, it can handle most, if not all, the tasks you've listed.
- Kann man von Open Source leben? Interview mit Martin Donath, der von Open Source lebt.
What are some alternatives?
dociql - A beautiful static documentation generator for GraphQL
Docusaurus - Easy to maintain open source documentation websites.
graphql-playground - 🎮 GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration)
sphinx - The Sphinx documentation generator
graphiql - GraphiQL & the GraphQL LSP Reference Ecosystem for building browser & IDE tools.
MkDocs - Project documentation with Markdown.
artwork - GraphQL Foundation artwork
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
graphdoc - Static page generator for documenting GraphQL Schema
Read the Docs - The source code that powers readthedocs.org
artwork - Contains the collaborative work of the openSUSE marketing and artwork teams. Content is licensed under CC-BY-SA 3.0 (Creative Commons Attribution-ShareAlike 3.0 Unported License).
mike - Manage multiple versions of your MkDocs-powered documentation via Git