spectaql
MkDocs
spectaql | MkDocs | |
---|---|---|
14 | 114 | |
1,047 | 18,293 | |
1.4% | 0.9% | |
6.8 | 9.0 | |
6 days ago | 8 days ago | |
JavaScript | Python | |
MIT License | BSD 2-clause "Simplified" 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
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
-
5 Best Static Site Generators in Python
MkDocs is a popular static site generator specifically designed for project documentation. It is built on Python's Markdown processing engine and comes with a clean and responsive default theme. MkDocs is easy to configure, and its simplicity makes it an excellent choice for quickly creating documentation for your projects.
-
Creating a knowledge base website for work, do I need a database or can it be only front end designed?
Take a look at https://www.mkdocs.org
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Examples with Github Pages?
I was thinking about using MkDocs, its usually used for documentation but I don't see why it couldn't be used for a normal wiki aswell. Since It's markdown you can just customize it like if it were a wiki, and a wiki doesn't really need backend stuff so I don't see a problem with it
What are some alternatives?
dociql - A beautiful static documentation generator for GraphQL
sphinx - The Sphinx documentation generator
graphql-playground - 🎮 GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration)
pdoc - API Documentation for Python Projects
graphiql - GraphiQL & the GraphQL LSP Reference Ecosystem for building browser & IDE tools.
DocFX - Static site generator for .NET API documentation.
artwork - GraphQL Foundation artwork
Hugo - The world’s fastest framework for building websites.
graphdoc - Static page generator for documenting GraphQL Schema
Docusaurus - Easy to maintain open source documentation websites.
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).
BookStack - A platform to create documentation/wiki content built with PHP & Laravel