https://github.com/Hugoberry/PowerQuery

The toolkit for extracting Power Query documentation from #shared and publishing it to GitBook
https://github.com/Hugoberry/PowerQuery

gitbook language-specification powerquery reference

Last synced: 3 months ago
JSON representation

The toolkit for extracting Power Query documentation from #shared and publishing it to GitBook

• Host: GitHub
• URL: https://github.com/Hugoberry/PowerQuery
• Owner: Hugoberry
• Archived: true
• Created: 2017-10-05T17:56:23.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-05T11:55:41.000Z (9 months ago)
• Last Synced: 2024-05-23T00:30:56.109Z (6 months ago)
• Topics: gitbook, language-specification, powerquery, reference
• Language: PowerShell
• Homepage: https://www.powerquery.io/
• Size: 2.19 MB
• Stars: 26
• Watchers: 9
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - Hugoberry/PowerQuery - The toolkit for extracting Power Query documentation from #shared and publishing it to GitBook (PowerShell)

README

        
# Power Query M Reference

> [!CAUTION]

> This repository has been archived and succeeded by [Hugoberry/powerquery-io](https://github.com/Hugoberry/powerquery-io)

This is a repository that contains the automated scrips for building an up to date Markdown verion of the Power Query M reference documentation. 

The documentation is sourced from #shared structure in Power BI desktop and is published to GitBooks. It is easily accessible via https://www.powerquery.io/ 

## Folder structure

```

│   book.json                -- GitBook configuration

│   doc2markdown.pq          -- Converts documentation to Markdown 

│   dox.pbix                 -- Sample file with PQ scripts

│   dox.pq                   -- Exposes the #shared documentation as Markdown

│   dox.ps1                  -- Exports the docs from PBIX file to file system

│   README.md

│   Signature.pq             -- Serializes the signature of a function

│

└───docs

    │   README.md             -- FrontPage

    │   SUMMARY.md            -- TOC

    │

    ├───Accessing data

    │   │   README.md         -- Documentation

    │   │

...

```

## How to run it

1. Open `dox.pbix` and hit refresh data. Leave the *Power BI Desktop* running

2. Run `dox.ps1` PowerShell script

3. Check with git for any documentation changes `git status`

4. Commit and push the changes to the `published` branch