Vitepress conversion of docs. (#23795)
This commit is contained in:
		
							parent
							
								
									395766657f
								
							
						
					
					
						commit
						6ef9717288
					
				
					 357 changed files with 3611 additions and 24208 deletions
				
			
		
							
								
								
									
										53
									
								
								.github/workflows/docs.yml
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										53
									
								
								.github/workflows/docs.yml
									
										
									
									
										vendored
									
									
								
							| 
						 | 
				
			
			@ -7,20 +7,26 @@ on:
 | 
			
		|||
  push:
 | 
			
		||||
    branches:
 | 
			
		||||
    - master
 | 
			
		||||
    - vitepress
 | 
			
		||||
    paths:
 | 
			
		||||
    - 'builddefs/docsgen/**'
 | 
			
		||||
    - 'tmk_core/**'
 | 
			
		||||
    - 'quantum/**'
 | 
			
		||||
    - 'platforms/**'
 | 
			
		||||
    - 'docs/**'
 | 
			
		||||
    - '.github/workflows/docs.yml'
 | 
			
		||||
 | 
			
		||||
defaults:
 | 
			
		||||
  run:
 | 
			
		||||
    shell: bash
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  generate:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    container: ghcr.io/qmk/qmk_cli
 | 
			
		||||
 | 
			
		||||
    # protect against those who develop with their fork on master
 | 
			
		||||
    if: github.repository == 'qmk/qmk_firmware'
 | 
			
		||||
    if: github.repository == 'qmk/qmk_firmware' || (github.repository == 'tzarc/qmk_firmware' && github.ref == 'refs/heads/vitepress')
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
    - uses: actions/checkout@v4
 | 
			
		||||
| 
						 | 
				
			
			@ -29,18 +35,51 @@ jobs:
 | 
			
		|||
 | 
			
		||||
    - name: Install dependencies
 | 
			
		||||
      run: |
 | 
			
		||||
        apt-get update && apt-get install -y rsync nodejs npm doxygen
 | 
			
		||||
        apt-get update && apt-get install -y rsync doxygen curl
 | 
			
		||||
        # install nvm
 | 
			
		||||
        touch $HOME/.bashrc
 | 
			
		||||
        curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
 | 
			
		||||
 | 
			
		||||
    - name: Install node
 | 
			
		||||
      run: |
 | 
			
		||||
        source $HOME/.bashrc
 | 
			
		||||
        nvm install 20
 | 
			
		||||
        nvm use 20
 | 
			
		||||
        corepack enable
 | 
			
		||||
        npm install -g moxygen
 | 
			
		||||
 | 
			
		||||
    - name: Build docs
 | 
			
		||||
      run: |
 | 
			
		||||
        source $HOME/.bashrc
 | 
			
		||||
        nvm use 20
 | 
			
		||||
        qmk --verbose generate-docs
 | 
			
		||||
        touch '.build/docs/.nojekyll'
 | 
			
		||||
 | 
			
		||||
    - name: Set CNAME
 | 
			
		||||
      if: github.repository == 'qmk/qmk_firmware'
 | 
			
		||||
      run: |
 | 
			
		||||
        # Override target CNAME
 | 
			
		||||
        echo 'docs.qmk.fm' > .build/docs/CNAME
 | 
			
		||||
 | 
			
		||||
    - name: Override CNAME
 | 
			
		||||
      if: github.repository == 'tzarc/qmk_firmware'
 | 
			
		||||
      run: |
 | 
			
		||||
        # Temporarily override target CNAME during development
 | 
			
		||||
        echo 'vitepress.qmk.fm' > .build/docs/CNAME
 | 
			
		||||
 | 
			
		||||
    - name: Deploy
 | 
			
		||||
      if: github.repository == 'qmk/qmk_firmware'
 | 
			
		||||
      uses: JamesIves/github-pages-deploy-action@v4.6.1
 | 
			
		||||
      with:
 | 
			
		||||
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
        BASE_BRANCH: master
 | 
			
		||||
        BRANCH: gh-pages
 | 
			
		||||
        FOLDER: .build/docs
 | 
			
		||||
        GIT_CONFIG_EMAIL: hello@qmk.fm
 | 
			
		||||
          token: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
          branch: gh-pages
 | 
			
		||||
          folder: .build/docs
 | 
			
		||||
          git-config-name: QMK Bot
 | 
			
		||||
          git-config-email: hello@qmk.fm
 | 
			
		||||
 | 
			
		||||
    - name: Deploy
 | 
			
		||||
      if: github.repository == 'tzarc/qmk_firmware'
 | 
			
		||||
      uses: JamesIves/github-pages-deploy-action@v4.6.1
 | 
			
		||||
      with:
 | 
			
		||||
        branch: gh-pages
 | 
			
		||||
        folder: .build/docs
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue