LNReader

https://www.lnreader.app/docs
Admin
This guide documents LNReader, an Android application for reading light novels, explaining...
Tokens:1,910
Snippets:40
Trust Score:5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and Launch Android App

Source: https://www.lnreader.app/docs/contributing

Deploys and starts the application on the connected Android device or emulator.

```bash
npm run android
```

--------------------------------

### Clone and Install Dependencies

Source: https://www.lnreader.app/docs/contributing

Initializes the local development environment by cloning the repository and installing required Node.js packages.

```bash
git clone https://github.com/<your-username>/lnreader.git
cd lnreader
npm install
```

--------------------------------

### Start Metro Bundler

Source: https://www.lnreader.app/docs/contributing

Launches the Metro bundler required for running the React Native application.

```bash
npm start
```

--------------------------------

### Build Release Version

Source: https://www.lnreader.app/docs/contributing

Validates the toolchain by attempting to produce a release build of the application.

```bash
npm run buildRelease
```

--------------------------------

### Run Linting

Source: https://www.lnreader.app/docs/contributing

Executes ESLint to ensure code quality standards are met before submitting a pull request.

```bash
npm run lint
```

--------------------------------

### Reader Settings CSS Variables

Source: https://www.lnreader.app/docs/custom-css-js

CSS variables available on :root to access current reader configuration settings.

```css
--readerSettings-theme         /* background color */
--readerSettings-padding       /* horizontal padding, e.g. 16px */
--readerSettings-textSize      /* font size, e.g. 16px */
--readerSettings-textColor     /* text color */
--readerSettings-textAlign     /* left | center | right | justify */
--readerSettings-lineHeight    /* line height, e.g. 1.5 */
--readerSettings-fontFamily    /* font family name */
```

--------------------------------

### Verify Device Connection

Source: https://www.lnreader.app/docs/contributing

Checks if the Android device or emulator is correctly recognized by the Android Debug Bridge.

```bash
adb devices
```

--------------------------------

### Style Headings CSS

Source: https://www.lnreader.app/docs/custom-css-js

Customizes chapter headings to match the primary theme colors.

```css
#LNReader-chapter h1,
#LNReader-chapter h2 {
  color: var(--theme-primary);
  border-bottom: 1px solid var(--theme-outline);
  padding-bottom: 0.3em;
}
```

--------------------------------

### Theme Color CSS Variables

Source: https://www.lnreader.app/docs/custom-css-js

CSS variables on :root representing the current theme color palette.

```css
--theme-primary
--theme-onPrimary
--theme-secondary
--theme-onSecondary
--theme-surface
--theme-onSurface
--theme-surfaceVariant
--theme-onSurfaceVariant
--theme-outline
```

--------------------------------

### Highlight Dialogue JavaScript

Source: https://www.lnreader.app/docs/custom-css-js

Wraps dialogue text in spans to apply theme-based coloring.

```javascript
chapter.querySelectorAll('p').forEach(p => {
  p.innerHTML = p.innerHTML.replace(
    /[""][^""]+[""]/g,
    match => `<span style="color: var(--theme-primary)">${match}</span>`
  );
});
```

--------------------------------

### Indent Paragraphs CSS

Source: https://www.lnreader.app/docs/custom-css-js

Applies indentation and spacing to chapter paragraphs.

```css
#LNReader-chapter p {
  text-indent: 2em;
  margin-bottom: 0.8em;
}
```

--------------------------------

### Round Images CSS

Source: https://www.lnreader.app/docs/custom-css-js

Applies border-radius to images within the chapter content.

```css
#LNReader-chapter img {
  border-radius: 8px;
}
```

--------------------------------

### Style TTS Highlight CSS

Source: https://www.lnreader.app/docs/custom-css-js

Customizes the appearance of text currently being read by TTS.

```css
.highlight {
  background-color: var(--theme-primary) !important;
  color: var(--theme-onPrimary) !important;
  border-radius: 3px;
}
```

--------------------------------

### Add Word Count JavaScript

Source: https://www.lnreader.app/docs/custom-css-js

Calculates and prepends a word count to the chapter content.

```javascript
const chapter = document.getElementById('LNReader-chapter');
const wordCount = chapter.innerText.trim().split(/\s+/).length;
const counter = document.createElement('p');
counter.style.cssText = 'opacity:0.5; font-size:0.85em; margin-bottom:1em;';
counter.textContent = `~${wordCount.toLocaleString()} words`;
chapter.prepend(counter);
```

--------------------------------

### Remove Ad Elements JavaScript

Source: https://www.lnreader.app/docs/custom-css-js

Removes elements identified as advertisements from the DOM.

```javascript
document.querySelectorAll('.ads, .ad-block, [class*="advertisement"]')
  .forEach(el => el.remove());
```

--------------------------------

### Remove Scrollbar CSS

Source: https://www.lnreader.app/docs/custom-css-js

Hides the scrollbar container element.

```css
#ToolWrapper {
  display: none;
}
```
Tokens:
Raw