chore: docs

This commit is contained in:
mathuo 2022-05-26 21:19:39 +01:00
parent b486e3ae58
commit bfee4c6a51
No known key found for this signature in database
GPG Key ID: C6EEDEFD6CA07281
13 changed files with 36 additions and 72 deletions

View File

@ -1,10 +1,10 @@
name: Deploy Docs
# on:
# schedule:
# - cron: '0 3 * * *' # every day at 3 am UTC
on:
schedule:
- cron: '0 3 * * *' # every day at 3 am UTC
on: [push]
# on: [push]
jobs:
deploy-nightly-demo-app:
@ -38,6 +38,6 @@ jobs:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs2 # The folder the action should deploy.
TARGET_FOLDER: docs2
FOLDER: build # The folder the action should deploy.
TARGET_FOLDER: .
CLEAN: true # Automatically remove deleted files from the deploy branch

View File

@ -1,42 +0,0 @@
name: Deploy Nightly Demo App
on:
schedule:
- cron: '0 3 * * *' # every day at 3 am UTC
# on: [push]
jobs:
deploy-nightly-demo-app:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v2.3.1 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
with:
persist-credentials: false
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: '16.x'
- uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-node-
- run: yarn
- run: npm run bootstrap
- run: npm run build
- run: npm run test
- run: npm run package-all
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: output # The folder the action should deploy.
TARGET_FOLDER: output
CLEAN: true # Automatically remove deleted files from the deploy branch

1
.gitignore vendored
View File

@ -12,3 +12,4 @@ storybook-static/
test-report.xml
*.code-workspace
yarn-error.log
/build

View File

@ -1,16 +0,0 @@
---
slug: dockview-1.4.3-release
title: Dockview 1.4.3
tags: [release]
---
# Release Notes
## 🚀 Features
- Small adjusted to behaviours of default paneview header componnet [#116](https://github.com/mathuo/dockview/pull/116)
- Improved support for external dnd events in the dockview component. `showDndOverlay` prop on `DockviewReact` exposes more parameters to interact with [#110](https://github.com/mathuo/dockview/pull/110)
## 🔥 Breaking changes
- Fix typo by renaming `onDidLayoutfromJSON` to `onDidLayoutFromJSON` in dockview component api [#112](https://github.com/mathuo/dockview/pull/112/files)

View File

@ -0,0 +1,24 @@
---
slug: dockview-1.4.3-release
title: Dockview 1.4.3
tags: [release]
---
# Release Notes
## 🚀 Features
- Small adjusted to behaviours of default paneview header componnet [#116](https://github.com/mathuo/dockview/pull/116) [#120](https://github.com/mathuo/dockview/pull/120)
- Improved support for external dnd events in the dockview component. `showDndOverlay` prop on `DockviewReact` exposes more parameters to interact with [#110](https://github.com/mathuo/dockview/pull/110)
- Improved to underlying events exposes through all components [#114](https://github.com/mathuo/dockview/pull/114)
- Add .clear() to the component APIs providing an easy way to clear a layout [#119](https://github.com/mathuo/dockview/pull/119)
- Udate orientation via componnet APIs is now working correctly [#119](https://github.com/mathuo/dockview/pull/119)
## 🛠 Miscs
- Documentation enhancements [#101](https://github.com/mathuo/dockview/pull/101)
- Move documentation to [dockview.dev](https://dockview.dev)
## 🔥 Breaking changes
- Fix typo by renaming `onDidLayoutfromJSON` to `onDidLayoutFromJSON` in dockview component api [#112](https://github.com/mathuo/dockview/pull/112/files)

View File

@ -5,7 +5,6 @@ const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const path = require('path');
const { DEPLOY_PATH } = require('./scripts/constants');
console.log(`isCI: ${process.env.CI}`);
@ -14,7 +13,7 @@ const config = {
title: 'Dockview',
tagline: 'Zero dependency layout manager for React',
url: 'https://your-docusaurus-test-site.com',
baseUrl: process.env.CI ? `/${DEPLOY_PATH}/` : '/',
baseUrl: process.env.CI ? `/` : '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',

View File

@ -1 +0,0 @@
module.exports = { DEPLOY_PATH: 'docs2' };

View File

@ -1,9 +1,8 @@
const fs = require('fs-extra');
const path = require('path');
const { DEPLOY_PATH } = require('./constants');
const output = path.join(__dirname, '../../');
const output = path.join(__dirname, '../../build');
const docsDir = path.join(__dirname, '../build');
fs.copySync(docsDir, path.join(output, DEPLOY_PATH));
fs.copySync(docsDir, path.join(output));

View File

Before

Width:  |  Height:  |  Size: 134 KiB

After

Width:  |  Height:  |  Size: 134 KiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

@ -259,7 +259,7 @@ export const TestGrid = (props: IGridviewPanelProps) => {
tabComponents={tabComponents}
onTabContextMenu={onTabContextMenu}
watermarkComponent={Watermark}
showDndOverlay={(ev, target) => {
showDndOverlay={(ev) => {
return true;
}}
onDidDrop={(ev) => {

View File

@ -5,4 +5,4 @@ const output = path.join(__dirname, '../');
const docsDir = path.join(__dirname, '../docs/build');
fs.copySync(docsDir, path.join(output, 'docs2'));
fs.copySync(docsDir, path.join(output, 'docs'));