Repository navigation
GitHub integration warning? #74
Description
Created a test repo codedoc having master as its default branch and configure gh-pages to the gh-pages branch. After which running:
# local system is archlinux
$codedoc initpopulates config.ts as:
// config.ts
import { configuration } from '@codedoc/core';
import { theme } from './theme';
export const config = /*#__PURE__*/configuration({
theme, // --> add the theme. modify `./theme.ts` for chaning the theme.
page: {
title: {
base: 'Codedoc' // --> the base title of your doc pages
}
},
});$codedoc check # No issues detectedSince my repo is in github (and gh-pages are already configured) I thought config.ts should have produced the github literal. Did I miss something? So I manually added the github integration as:
// config.ts
import { configuration } from '@codedoc/core';
import { theme } from './theme';
export const config = /*#__PURE__*/configuration({
theme, // --> add the theme. modify `./theme.ts` for chaning the theme.
page: {
title: {
base: 'Codedoc' // --> the base title of your doc pages
}
},
dest: {
html: 'dist',
assets: 'dist',
namespace: '/codedoc'
},
misc: {
github: {
user: 'nakednous',
repo: 'codedoc',
action: 'Star',
count: false,
large: true,
standardIcon: false,
}
},
});However, running codedoc check produces the following warning:
$codedoc check
# Checking GitHub configuration ...
#
# WARNING::
# Your CODEDOC config indicates GitHub integration, but
# your project folder is not in sync with a GitHub repository.
#
# You can fix this by modifying .codedoc/config.ts
#
# Read https://codedoc.cc/docs/config/misc#github-integration for more information.
#Is it an issue or is it just my config?
Activity
TysonMN commentedon Oct 11, 2020
At what URL do you want your site served?
nakednous commentedon Oct 11, 2020
https://nakednous.github.io/codedocI added the github yml to the actual repo and it worked as expected. I was wondering about the warning I'm getting.
loreanvictor commentedon Oct 12, 2020
@nakednous may I ask:
codedoc vnakednous commentedon Oct 12, 2020
I used https. Have no keys configured, but try to clone with
gh repo cloneand the warning message has gone.loreanvictor commentedon Oct 12, 2020
So I just tried to replicate the issue doing the following:
And I get no warnings. Can you run this command in the cloned folder where you get the warning and reply the result?
nakednous commentedon Oct 12, 2020
I get:
https://github.com/nakednous/codedoc